Permalink
Browse files

doc/setup.py updates

  • Loading branch information...
1 parent 4be09fd commit aad900a8e3727f200885bd254d7935ec09afd58f @mreiferson mreiferson committed Oct 31, 2012
Showing with 8 additions and 6 deletions.
  1. +1 −0 .gitignore
  2. +5 −4 README.md
  3. +2 −2 setup.py
View
@@ -1,2 +1,3 @@
dist
*.pyc
+pynsq.egg-info
View
@@ -1,15 +1,15 @@
## pynsq
-`pynsq` is a Python NSQ client library.
+`pynsq` is the official Python client library for [NSQ][nsq].
It provides a high-level reader library for building consumers and two low-level modules for both
-sync and async communication over the NSQ protocol (if you wanted to write your own high-level
-functionality).
+sync and async communication over the [NSQ][nsq] protocol (if you wanted to write your own
+high-level functionality).
The async module is built on top of the [Tornado IOLoop][tornado] and as such requires `tornado` be
installed:
-`$ pip install tornado`
+ $ pip install tornado
### Reader
@@ -91,4 +91,5 @@ r = nsq.Reader(all_tasks, lookupd_http_addresses=['http://127.0.0.1:4161'],
nsq.run()
```
+[nsq]: https://github.com/bitly/nsq
[tornado]: https://github.com/facebook/tornado
View
@@ -8,8 +8,8 @@
keywords='python nsq',
author='Matt Reiferson',
author_email='snakes@gmail.com',
- url='http://github.com/bitly/nsq/pynsq',
- download_url='https://github.com/downloads/bitly/nsq/pynsq-%s.tar.gz' % version,
+ url='http://github.com/bitly/pynsq',
+ download_url='https://github.com/downloads/bitly/pynsq/pynsq-%s.tar.gz' % version,
packages=['nsq'],
include_package_data=True,
zip_safe=True,

0 comments on commit aad900a

Please sign in to comment.