Skip to content

Commit e45c18f

Browse files
authored
Merge pull request #31 from exceptionless/testing
Updated readme
2 parents f5df9cf + fbe8f1b commit e45c18f

File tree

1 file changed

+49
-3
lines changed

1 file changed

+49
-3
lines changed

Readme.md

Lines changed: 49 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,51 @@
1-
# Exceptionless.Java [In Progress...]
1+
# Exceptionless.Java
22

3-
Java cleint for [Exceptionless](https://exceptionless.com/)
3+
The definition of the word exceptionless is: to be without exception. [Exceptionless](https://exceptionless.io) provides real-time error reporting for your Java apps. It organizes the gathered information into simple actionable data that will help your app become exceptionless!
44

5-
`google-java-format` is used for code-formatting
5+
## Using Exceptionless
6+
7+
Refer to the Exceptionless documentation here: [Exceptionless Docs](http://docs.exceptionless.io).
8+
9+
### Warning! This package is still in Beta and not yet published to Maven Central. If you need it right now feel free to contact us on [Discord]((https://discord.gg/6HxgFCx)) or create an [Issue](https://github.com/exceptionless/Exceptionless.Java/issues/new).
10+
11+
## Show me the code!
12+
13+
```java
14+
class ExampleApp{
15+
public static void main(String[] args) {
16+
private static final ExceptionlessClient client =
17+
ExceptionlessClient.from(
18+
System.getenv("EXCEPTIONLESS_SAMPLE_APP_API_KEY"),
19+
System.getenv("EXCEPTIONLESS_SAMPLE_APP_SERVER_URL"));
20+
21+
// Submit different events using submitXXX methods
22+
client.submitLog("Test log");
23+
24+
// Submit custom methods using our createXXX methods
25+
client.submitEvent(
26+
EventPluginContext.from(
27+
client.createLog("test-log").referenceId("test-reference-id").build()));
28+
29+
// Submit async events using submitXXXAsync methods
30+
client.submitLogAsync("Test log");
31+
}
32+
}
33+
```
34+
35+
## General Data Protection Regulation
36+
37+
By default the Exceptionless Client will report all available metadata including potential PII data.
38+
You can fine tune the collection of information via Data Exclusions or turning off collection completely.
39+
40+
Please visit the [docs](https://exceptionless.com/docs/clients/javascript/client-configuration/#general-data-protection-regulation)
41+
for detailed information on how to configure the client to meet your requirements.
42+
43+
## Support
44+
45+
If you need help, please contact us via in-app support, [open an issue](https://github.com/exceptionless/Exceptionless.Java/issues/new) or [join our chat on Discord](https://discord.gg/6HxgFCx). We’re always here to help if you have any questions!
46+
47+
## Thanks
48+
49+
Thanks to all the people who have contributed!
50+
51+
[![contributors](https://contributors-img.web.app/image?repo=exceptionless/Exceptionless.Java)](https://github.com/exceptionless/Exceptionless.JavaScript/graphs/contributors)

0 commit comments

Comments
 (0)