Skip to content

Commit 4ab5761

Browse files
committed
pip install instructions
1 parent 867a0b0 commit 4ab5761

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,20 @@ You can get a feel of how to use the websocket server by running
2222
Then just open `client.html` in your browser and you should be able to send and receive messages.
2323

2424

25-
Using on your project
25+
Using in your project
2626
=======================
27-
In order to use the websocket server in your project, simply
28-
copy `websocket.py` to your project and `from websocket import WebsocketServer`.
29-
Then use the documented API below to manage the behaviour of your server.
27+
You can either simply copy/pase the *websocket_server.py* file in your project and use it directly
28+
or you can install the project directly from PyPi:
3029

31-
By default the server doesn't do anything when events occur.
30+
pip install websocket-server
31+
32+
For further details check the [*server.py*](https://github.com/Pithikos/python-websocket-server/blob/master/server.py) example code and the [API](https://github.com/Pithikos/python-websocket-server#api).
3233

3334

3435
API
3536
=======================
3637

37-
The API is simply methods and properties of a `WebsocketServer` instance.
38+
The API is simply methods and properties of the `WebsocketServer` class.
3839

3940
## WebsocketServer
4041

0 commit comments

Comments
 (0)