Merge pull request #111 from pyiron/improve_descriptions

Improve documentation

Author: liamhuber

README.md

@@ -10,7 +10,7 @@ Ironflow combines [ryven](https://ryven.org), [ipycanvas](https://ipycanvas.read
 This project is under active development, and in particular the set of nodes available for the workflow graphs is still limited. 
 If there is a particular use-case you'd like to see, or if one of our nodes is not working as expected, please raise an issue!
 
-![](screenshot.png)
+![](docs/_static/screenshot.png)
 
 ## Usage
 

docs/_static/screenshot.png

@@ -7,8 +7,29 @@
 ironflow
 =========
 
+.. image:: https://mybinder.org/badge_logo.svg
+    :target: https://mybinder.org/v2/gh/pyiron/ironflow/HEAD?labpath=example.ipynb
+    :alt: Launch MyBinder
+
+.. image:: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg
+    :target: https://opensource.org/licenses/BSD-3-Clause
+    :alt: License
+
+.. image:: https://app.codacy.com/project/badge/Grade/f21027e6a1fd40bd8ff93b0314a64725
+    :target: https://www.codacy.com/gh/pyiron/ironflow/dashboard?utm_source=github.com&utm_medium=referral&utm_content=pyiron/ironflow&utm_campaign=Badge_Grade
+    :alt: Codacy
+
+.. image:: https://coveralls.io/repos/github/pyiron/ironflow/badge.svg?branch=main
+    :target: https://coveralls.io/github/pyiron/ironflow?branch=main
+    :alt: Coveralls test coverage
+
+Ironflow combines `ryven <https://ryven.org>`_, `ipycanvas <https://ipycanvas.readthedocs.io/>`_ and `ipywidgets <https://ipywidgets.readthedocs.io/en/stable/>`_ to provide a Jupyter-based visual scripting gui for running `pyiron <https://pyiron.org>`_ workflow graphs.
+
+.. image:: _static/screenshot.png
+   :align: center
+   :alt: Screenshot of ironflow running inside jupyterlab.
 
 .. toctree::
    :hidden:
 
-    source/indices.rst
+   source/indices.rst

docs/index.rst

@@ -4,6 +4,7 @@
 API Documentation
 =================
 
+* :ref:`genindex`
 * :ref:`modindex`
 
 

docs/source/indices.rst

@@ -7,8 +7,9 @@
 setup(
     name='ironflow',
     version=versioneer.get_version(),
-    description='ironflow - module extension to pyiron.',
-    long_description='http://pyiron.org',
+    description='ironflow - A visual scripting interface for pyiron.',
+    long_description='Ironflow combines ryven, ipycanvas and ipywidgets to provide a Jupyter-based visual scripting '
+                     'gui for running pyiron workflow graphs.',
 
     url='https://github.com/pyiron/ironflow',
     author='Max-Planck-Institut für Eisenforschung GmbH - Computational Materials Design (CM) Department',