Skip to content

Commit 732031e

Browse files
authored
Merge pull request TooTallNate#858 from marci4/Issue755
Update documentation for 1.4.0
2 parents 6aa3b1f + 77473d8 commit 732031e

File tree

3 files changed

+24
-8
lines changed

3 files changed

+24
-8
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ A link to a github project/gist to reproduce the issue.
2121
A clear and concise description of what you expected to happen.
2222

2323
**Debug log**
24-
The the debug log ('WebSocketImpl.DEBUG = true') to help explain your problem.
24+
The the debug log (set the log level to `TRACE`) to help explain your problem.
2525

2626
**Environment(please complete the following information):**
2727
- Version used:

README.markdown

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,13 @@ Implemented WebSocket protocol versions are:
1717
[Here](https://github.com/TooTallNate/Java-WebSocket/wiki/Drafts) some more details about protocol versions/drafts.
1818

1919

20-
## Build
21-
You can build using Maven, Gradle or Leiningen but there is nothing against just putting the source path ```src/main/java ``` on your applications buildpath.
20+
## Getting Started
2221

23-
### Maven
22+
### Dependency management tools
23+
24+
Below is a brief guide to using dependency management tools like maven or gradle.
25+
26+
#### Maven
2427
To use maven add this dependency to your pom.xml:
2528
```xml
2629
<dependency>
@@ -30,8 +33,8 @@ To use maven add this dependency to your pom.xml:
3033
</dependency>
3134
```
3235

33-
### Gradle
34-
To use Gradle add the maven central repository to your repositories list :
36+
#### Gradle
37+
To use Gradle add the maven central repository to your repositories list:
3538
```xml
3639
mavenCentral()
3740
```
@@ -40,6 +43,20 @@ Then you can just add the latest version to your build.
4043
compile "org.java-websocket:Java-WebSocket:1.3.9"
4144
```
4245

46+
#### Logging
47+
48+
This library uses [SLF4J](https://www.slf4j.org/) for logging and does not ship with any default logging implementation.
49+
50+
Exceptions are using the log level `ERROR` and debug logging will be done with log level `TRACE`.
51+
52+
Feel free to use whichever logging framework you desire and use the corresponding [binding](https://mvnrepository.com/artifact/org.slf4j) in your dependency management.
53+
54+
If you want to get started, take a look at the SimpleLogger [example](https://github.com/TooTallNate/Java-WebSocket/wiki/SimpleLogger-example).
55+
56+
### Standalone jar
57+
58+
If you do not use any dependency management tool, you can find the latest standalone jar [here](https://github.com/TooTallNate/Java-WebSocket/releases/latest).
59+
4360
Writing your own WebSocket Server
4461
---------------------------------
4562

@@ -98,7 +115,6 @@ Minimum Required JDK
98115

99116
Other JRE implementations may work as well, but haven't been tested.
100117

101-
102118
License
103119
-------
104120

src/main/example/simplelogger.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
org.slf4j.simpleLogger.logFile=System.out
2-
org.slf4j.simpleLogger.defaultLogLevel=error
2+
org.slf4j.simpleLogger.defaultLogLevel=trace
33
org.slf4j.simpleLogger.showDateTime=true
44
org.slf4j.simpleLogger.dateTimeFormat=yyyy-MM-dd HH:mm:ss.SSS
55
org.slf4j.simpleLogger.showThreadName=false

0 commit comments

Comments
 (0)