Improve readme

[haesleinhuepf]

Description

Hi Johannes @jo-mueller ,
CC Marcelo @zoccoler

in response to #32 I'm just sending an update to the readme. This readme will be shown on pypi and thus, I'm convinced that it should look good. Let me know what you think and if you think it's ok, feel free to merge and publish on pypi.

Also, after merging and publishing on pypi, please

• check if all links are working,
• if the figures are shown and
• make Marcelo and myself co-owners of the repository on pypi, so that we could publish releases as well, just in case.

Type of change

• Bug-fix
• New feature
• Breaking change
• Documentation update

References

closes #32

Tests

• I adapted existing tests, because
• I added new tests to cover the code change
• All tests pass with my change

Documentation

• I rebuilt the documentation page to ensure building the pages works
• I used PEP-8 conformal code styling

Final checks

• My change is the minimal possible work for the desired feature/fix
• I updated the documentation where necessary to cover the change

[jo-mueller]

Hi Robert @haesleinhuepf ,

This readme will be shown on pypi and thus, I'm convinced that it should look good.

I totally agree. I made some minor changes to the text. I think in future releases we could talk about what should be documented where (Readme.md vs. gh-pages) but I think for now this is the perfect opener to show at a glance what can be done.