Skip to content

Commit

Permalink
Merge pull request #2 from martinohanlon/dev
Browse files Browse the repository at this point in the history
update readme
  • Loading branch information
Martin O'Hanlon committed Jul 10, 2018
2 parents 8eab6c4 + e3381b0 commit 7efd459
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ quickdraw

``quickdraw`` is an API for accessing the `Quick Draw data`_ - it downloads the data files as and when needed, caches them locally and interprets them so they can be used.

|quickdrawpreview|

Created by `Martin O'Hanlon`_ (`@martinohanlon`_, `stuffaboutco.de`_).

Getting started
Expand Down Expand Up @@ -68,6 +70,8 @@ You can save the drawing using the ``image`` property.
anvil.image.save("my_anvil.gif")
|myanvil|

You can open a group of Quick Draw drawings using `QuickDrawDataGroup`_ passing the name of the drawing ("anvil", "aircraft", "baseball", etc).

.. code-block:: python
Expand Down Expand Up @@ -131,7 +135,11 @@ Status
:scale: 100 %
:alt: quickdraw

.. |quickdrawpreview| image:: https://raw.githubusercontent.com/martinohanlon/quickdraw_python/master/docs/images/quickdraw_preview.png
.. |quickdrawpreview| image:: https://raw.githubusercontent.com/martinohanlon/quickdraw_python/master/docs/images/quickdraw_preview.jpg
:scale: 100 %
:alt: quickdraw_preview

.. |myanvil| image:: https://raw.githubusercontent.com/martinohanlon/quickdraw_python/master/docs/images/myanvil.png
:scale: 100 %
:alt: quickdraw_preview

Expand Down
Binary file added docs/images/my_anvil.gif
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 7efd459

Please sign in to comment.