Skip to content

Commit

Permalink
Merge pull request TooTallNate#858 from marci4/Issue755
Browse files Browse the repository at this point in the history
Update documentation for 1.4.0
  • Loading branch information
marci4 authored Feb 19, 2019
2 parents 6aa3b1f + 77473d8 commit 732031e
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
28 changes: 22 additions & 6 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
<dependency>
Expand All @@ -30,8 +33,8 @@ To use maven add this dependency to your pom.xml:
</dependency>
```

### 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()
```
Expand All @@ -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
---------------------------------

Expand Down Expand Up @@ -98,7 +115,6 @@ Minimum Required JDK

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


License
-------

Expand Down
2 changes: 1 addition & 1 deletion src/main/example/simplelogger.properties
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 732031e

Please sign in to comment.