Skip to content

Commit d0376fe

Browse files
committed
update readme
1 parent b7491bc commit d0376fe

File tree

2 files changed

+24
-5
lines changed

2 files changed

+24
-5
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,12 @@ If you wanna modify the source code:
2020
3. `npm run dev` to start webpack-dev-server (with react-hot-loader)
2121
4. open `http://localhost:4040`
2222

23-
## Spring-based server
23+
## Spring-based & Netty-based server
2424

2525
There is a spring-based WebSocket server in the [java](java) folder for test purpose. View [Doc](java/README.md).
2626

27+
There is also a netty-based example server.
28+
2729
## Browsers support
2830

2931
| [<img src="https://raw.githubusercontent.com/godban/browsers-support-badges/master/src/images/chrome.png" alt="Chrome" width="16px" height="16px" />](http://godban.github.io/browsers-support-badges/)</br>Chrome |

java/README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
# A spring-based WebSocket server for test
1+
# WebSocket server for test
22

3-
With Spring 4.2.6.
3+
## Spring-based
44

5-
## Quick Start
5+
Based on Spring 4.2.6
6+
7+
### Quick Start
68

79
1. you need maven 3.
810
2. `git clone` and `mvn jetty:run` to start the embedded Jetty server.
911
3. open `http://localhost:8080/index.html` and enjoy.
1012

11-
## WebSocket URI
13+
### WebSocket URI
1214

1315
Once the Jetty server started, there are some URI available for WebSocket transport:
1416

@@ -17,3 +19,18 @@ Once the Jetty server started, there are some URI available for WebSocket transp
1719
3. `http://localhost:8080/stomp` for SockJS + STOMP.
1820

1921
For more detail, view [SpringMVC.xml](src/main/resources/springMVC.xml).
22+
23+
## Netty-based
24+
25+
Based on Netty 4.1.9.Final
26+
27+
### Quick Start
28+
29+
1. you need maven 3.
30+
2. `git clone` and `mvn jetty:run`
31+
3. open a new terminal window and `mvn exec:java -Dexec.mainClass=me.jxy.websocket.netty.Demo`
32+
4. open `http://localhost:8080/index.html`
33+
34+
### WebSocket URI
35+
36+
This server is very simple, just a demo. Only one URI `ws://localhost:12345/websocket` is available for raw WebSocket.

0 commit comments

Comments
 (0)