diff --git a/README.org b/README.org deleted file mode 100644 index 46aa821..0000000 --- a/README.org +++ /dev/null @@ -1,50 +0,0 @@ -* dotter - -[[https://travis-ci.org/paetzke/dotter][https://travis-ci.org/paetzke/dotter.png?branch=master]] -[[https://coveralls.io/r/paetzke/dotter?branch=master][https://coveralls.io/repos/paetzke/dotter/badge.png?branch=master]] -[[https://pypi.python.org/pypi/dotter/][https://pypip.in/v/dotter/badge.png]] - -Dotter is a graphviz wrapper for Python 2 and 3. In order to use it you need graphviz. -On Debian/Ubuntu you can install it by typing: - -#+BEGIN_SRC bash -$ apt-get install graphviz -#+END_SRC - -After that install =dotter= via =pip=. - -#+BEGIN_SRC bash -$ pip install dotter -#+END_SRC - -[[https://paetzke.me/static/images/dotter.png]] - -An usage example: - -#+BEGIN_SRC python -from dotter import Dotter - - -dotter = Dotter() - -dotter.add_node('a', label='b') -dotter.add_node('b', label='c') -dotter.add_edge('a', 'b') -dotter.close() -#+END_SRC - - -** Bugs and improvements - -Feel free to open tickets or send pull requests with improvements. -These [[https://github.com/paetzke/dotter/graphs/contributors][contributors]] have done so. - - - -** Copyright - -Copyright (c) 2013-2015 Friedrich Pätzke. -See [[LICENSE]] for further details. - - -See you. [[https://twitter.com/paetzke][Friedrich]]. diff --git a/README.rst b/README.rst index 2bad03d..e58b236 100644 --- a/README.rst +++ b/README.rst @@ -3,9 +3,9 @@ dotter .. image:: https://travis-ci.org/paetzke/dotter.png?branch=master :target: https://travis-ci.org/paetzke/dotter -.. image:: https://coveralls.io/repos/paetzke/dotter/badge.png?branch=master +.. image:: https://coveralls.io/repos/paetzke/dotter/badge.svg?branch=master&service=github :target: https://coveralls.io/r/paetzke/dotter?branch=master -.. image:: https://pypip.in/v/dotter/badge.png +.. image:: https://badge.fury.io/py/dotter.svg :target: https://pypi.python.org/pypi/dotter/ Dotter is a graphviz wrapper for Python 2 and 3. In order to use it you need graphviz. @@ -21,17 +21,17 @@ After that install ``dotter`` via ``pip``. $ pip install dotter -.. image:: https://paetzke.me/static/images/dotter.png +.. image:: https://raw.githubusercontent.com/paetzke/dotter/update-readme/docs/dotter.png An usage example: .. code:: python from dotter import Dotter - - + + dotter = Dotter() - + dotter.add_node('a', label='b') dotter.add_node('b', label='c') dotter.add_edge('a', 'b') @@ -50,4 +50,3 @@ Copyright (c) 2013-2015 Friedrich Pätzke. See `LICENSE `_ for further details. See you. `Friedrich `_. - diff --git a/docs/dotter.png b/docs/dotter.png new file mode 100644 index 0000000..0b7c468 Binary files /dev/null and b/docs/dotter.png differ