Merge pull request #33 from BiAPoL/improve-readme

Improve readme

README.md

@@ -4,15 +4,52 @@
 [![Contributors](https://img.shields.io/github/contributors-anon/BiAPoL/biapol-utilities)](https://github.com/BiAPoL/biapol-utilities/graphs/contributors)
 [![codecov](https://codecov.io/gh/BiAPoL/biapol-utilities/branch/master/graph/badge.svg)](https://codecov.io/gh/BiAPoL/biapol-utilities)
 
-Collection of utility functions from the biapol group at DFG cluster of excellence "Physics of Life" (POL) @ TU Dresden, Dresden, Germany
+Collection of utility functions from the BiA-PoL group at the DFG Cluster of Excellence "Physics of Life" (PoL) @ TU Dresden, Germany. 
 
-## Ressources:
+## Usage 
+
+This library contains functions for comparing and visualizing label images. For example, comparing label images is as easy as this:
+```python
+import biapol_utilities as biau
+
+biau.label.compare_labels(ground_truth, segmented)
+```
+![img.png](docs/_static/example_table.png)
+
+In another example, you can visualize a label image with a nice color map like this:
+
+```python
+import biapol_utilities as biau
+from skimage.io import imshow
+
+imshow(label_image, cmap=biau.labels_colormap(), vmin=0, vmax=labels.max())
+```
+![img.png](docs/_static/example_label_image.png)
+
+We provide examples to most of our functionality on our [documentation](https://biapol.github.io/biapol-utilities/_include/Examples.html). The examples are also available as [jupyter notebooks](https://github.com/BiAPoL/biapol-utilities/tree/main/docs/_include/notebooks/label).
+
+## Installation
+
+`biapol-utilities` can be installed using pip:
+
+`pip install biapol-utilities`
+
+If you want to develop `biapol-utilities` you can download and install it like this:
+
+```
+git clone https://github.com/BiAPoL/biapol-utilities
+cd biapol-utilities
+pip install -e .
+```
+
+## Ressources
 
 * [Documentation](https://biapol.github.io/biapol-utilities)
 * [Source code](https://github.com/BiAPoL/biapol-utilities)
 * [Bug reports are welcome here](https://github.com/BiAPoL/biapol-utilities/issues)
-* [Contribute](https://biapol.github.io/biapol-utilities/_build/html/_include/Contribute.html)
+* [How to contribute](https://biapol.github.io/biapol-utilities/_include/Contribute.html)
 
 ## Acknowledgements
-Developing biapol-utilities is a community effort. We would like to thank everybody who helped developing and testing. In particular, thanks goes to the contributions of 
-- the developers of cellpose for label-matching functions
+Developing biapol-utilities is a community effort. We would like to thank everybody who helped developing and testing. 
+Furthermore, we are gladly re-using code from other open source projects. 
+See the the [thirdparty-licenses folder](https://github.com/BiAPoL/biapol-utilities/tree/main/license_thirdparty) for details.

setup.cfg

@@ -1,7 +1,7 @@
 [metadata]
 name = biapol-utilities
 version = 0.0.1
-author = Johannes Müller
+author = Johannes Müller, Robert Haase
 author_email = johannes_richard.mueller@tu-dresden.de
 
 license = BSD-3-Clause