Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jiangxy committed Apr 18, 2017
1 parent 00f27bd commit 370ad9a
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,31 @@
# websocket debug tool

A tool to debug websocket/sockjs/stomp.

![](screenshot.png)

# Features

* support WebSocket/[SockJS](https://github.com/sockjs/sockjs-client), with or without [STOMP](https://github.com/jmesnil/stomp-websocket)
* React + ES6 + webpack + [Ant Design](https://github.com/ant-design/ant-design)

# Quick Start

Open [http://jiangxy.github.io/websocket-debug-tool](http://jiangxy.github.io/websocket-debug-tool) and use directly.

If you wanna modify the source code:

1. node 5.3, npm 3.3+
2. `git clone` and `npm install`
3. `npm run dev` to start webpack-dev-server
4. open `http://localhost:4040`

# Spring-based server

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

# Browsers support

| [<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 |
| --------- |
| last 2 versions
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 370ad9a

Please sign in to comment.