Skip to content

Commit

Permalink
Updated readme and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Tsukasa Hiiragi committed Jul 31, 2014
1 parent 418c6f6 commit 63864da
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,23 @@ So far you can only retrieve the data for the public objects, for which no login
>>> client = deezer.Client()
>>> client.get_album(12).title
u'Monkey Business'


You also can use AsyncClient with tornado.

>>> from tornado.gen import coroutine
>>> from tornado.ioloop import IOLoop
>>> from deezer import AsyncClient
>>>
>>>
>>> @coroutine
... def main():
... client = AsyncClient()
... album = yield client.get_album(12)
... print(album.title)
...
>>> IOLoop.instance().run_sync(main)
Monkey Business

See the whole API on the [Sphinx](http://sphinx-doc.org/) generated [documentation](http://deezer-python.readthedocs.org/).

Authentication
Expand Down
5 changes: 5 additions & 0 deletions docs/source/async.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Async module
-------------

.. automodule:: deezer.async
:members:
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,6 @@ Contents:

.. toctree::

async
client
resources

0 comments on commit 63864da

Please sign in to comment.