Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated README and added xeross to list of contributors.

  • Loading branch information...
commit 7a5ddbd8b63b31c8e5fb967de44b7ad93e7a72d9 1 parent 303d141
@zeekay authored
Showing with 16 additions and 2 deletions.
  1. +13 −0 README.md
  2. +3 −2 setup.py
View
13 README.md
@@ -1,5 +1,13 @@
This project adds websocket capabilities to [bottle](http://bottlepy.org), leveraging [gevent-websocket](http://www.gelens.org/code/gevent-websocket/) and [gevent](http://www.gevent.org/).
+Install
+=======
+Use `pip` or `easy_install`:
+
+ pip install bottle-websocket
+
+Usage
+=====
Usage is pretty straight-forward, just import the server and plugin:
from bottle.ext.websocket import GeventWebSocketServer
@@ -18,3 +26,8 @@ You can use the websocket plugin to turn routes websocket handlers, the websocke
And then use the provided server:
run(host='127.0.0.1', port=8080, server=GeventWebSocketServer)
+
+Contributors
+============
+[zeekay](https://github.com/zeekay)
+[xeros](https://github.com/xeross)
View
5 setup.py
@@ -1,11 +1,12 @@
-from distutils.core import setup
+from setuptools import setup
setup(
name='bottle-websocket',
- version='0.1',
+ version='0.2',
author='Zach Kelling',
author_email='zeekayy@gmail.com',
packages=['bottle_websocket',],
description='WebSockets for bottle',
long_description=open('README.md').read(),
+ install_requires=['bottle', 'gevent-websocket'],
)
Please sign in to comment.
Something went wrong with that request. Please try again.