diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 4026c3b75..717863a0e 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -21,7 +21,7 @@ A link to a github project/gist to reproduce the issue. A clear and concise description of what you expected to happen. **Debug log** -The the debug log ('WebSocketImpl.DEBUG = true') to help explain your problem. +The the debug log (set the log level to `TRACE`) to help explain your problem. **Environment(please complete the following information):** - Version used: diff --git a/README.markdown b/README.markdown index 82f2ce436..4797d133d 100644 --- a/README.markdown +++ b/README.markdown @@ -17,10 +17,13 @@ Implemented WebSocket protocol versions are: [Here](https://github.com/TooTallNate/Java-WebSocket/wiki/Drafts) some more details about protocol versions/drafts. -## Build -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. +## Getting Started -### Maven +### Dependency management tools + +Below is a brief guide to using dependency management tools like maven or gradle. + +#### Maven To use maven add this dependency to your pom.xml: ```xml @@ -30,8 +33,8 @@ To use maven add this dependency to your pom.xml: ``` -### Gradle -To use Gradle add the maven central repository to your repositories list : +#### Gradle +To use Gradle add the maven central repository to your repositories list: ```xml mavenCentral() ``` @@ -40,6 +43,20 @@ Then you can just add the latest version to your build. compile "org.java-websocket:Java-WebSocket:1.3.9" ``` +#### Logging + +This library uses [SLF4J](https://www.slf4j.org/) for logging and does not ship with any default logging implementation. + +Exceptions are using the log level `ERROR` and debug logging will be done with log level `TRACE`. + +Feel free to use whichever logging framework you desire and use the corresponding [binding](https://mvnrepository.com/artifact/org.slf4j) in your dependency management. + +If you want to get started, take a look at the SimpleLogger [example](https://github.com/TooTallNate/Java-WebSocket/wiki/SimpleLogger-example). + +### Standalone jar + +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). + Writing your own WebSocket Server --------------------------------- @@ -98,7 +115,6 @@ Minimum Required JDK Other JRE implementations may work as well, but haven't been tested. - License ------- diff --git a/src/main/example/simplelogger.properties b/src/main/example/simplelogger.properties index f2f4dcac3..aa4322e92 100644 --- a/src/main/example/simplelogger.properties +++ b/src/main/example/simplelogger.properties @@ -1,5 +1,5 @@ org.slf4j.simpleLogger.logFile=System.out -org.slf4j.simpleLogger.defaultLogLevel=error +org.slf4j.simpleLogger.defaultLogLevel=trace org.slf4j.simpleLogger.showDateTime=true org.slf4j.simpleLogger.dateTimeFormat=yyyy-MM-dd HH:mm:ss.SSS org.slf4j.simpleLogger.showThreadName=false