Merge pull request #5 from TUW-GEO/readme

Update readme

CHANGES.rst

@@ -2,6 +2,11 @@
 Changelog
 =========
 
+Version 0.X
+===========
+
+- Update readme
+
 Version 0.4
 ===========
 

README.rst

@@ -11,8 +11,9 @@ repurpose
 .. image:: https://badge.fury.io/py/repurpose.svg
     :target: http://badge.fury.io/py/repurpose
 
-.. image:: https://zenodo.org/badge/12761/TUW-GEO/repurpose.svg
-   :target: https://zenodo.org/badge/latestdoi/12761/TUW-GEO/repurpose
+.. image:: https://readthedocs.org/projects/repurpose/badge/?version=latest
+   :target: http://repurpose.readthedocs.org/
+
 
 This package provides routines for the conversion of image formats to time
 series and vice versa. It is part of the `poets° project
@@ -26,6 +27,30 @@ The readers and writers have to conform to the API specifications of the base
 classes defined in `pygeobase <https://github.com/TUW-GEO/pygeobase>`_ to work
 without adpation.
 
+Citation
+========
+
+.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.593577.svg
+   :target: https://doi.org/10.5281/zenodo.593577
+
+If you use the software in a publication then please cite it using the Zenodo DOI.
+Be aware that this badge links to the latest package version.
+
+Please select your specific version at https://doi.org/10.5281/zenodo.593577 to get the DOI of that version.
+You should normally always use the DOI for the specific version of your record in citations.
+This is to ensure that other researchers can access the exact research artefact you used for reproducibility.
+
+You can find additional information regarding DOI versioning at http://help.zenodo.org/#versioning
+
+Installation
+============
+
+This package should be installable through pip:
+
+.. code::
+
+    pip install repurpose
+
 Modules
 =======
 
@@ -36,14 +61,6 @@ It includes two main modules:
 - ``ts2img`` for time series to image conversion, including support for temporal
   resampling. This module is very experimental at the moment.
 
-Documentation
-=============
-
-|Documentation Status|
-
-.. |Documentation Status| image:: https://readthedocs.org/projects/repurpose/badge/?version=latest
-   :target: http://repurpose.readthedocs.org/
-
 Alternatives
 ============
 
@@ -61,6 +78,30 @@ might be better suited to your needs.
 - `netCDF Operators (NCO) <http://nco.sourceforge.net/#Definition>`_ are similar
   to CDO with a stronger focus on netCDF.
 
+Contribute
+==========
+
+We are happy if you want to contribute. Please raise an issue explaining what
+is missing or if you find a bug. We will also gladly accept pull requests
+against our master branch for new features or bug fixes.
+
+Development setup
+-----------------
+
+For Development we recommend a ``conda`` environment
+
+Guidelines
+----------
+
+If you want to contribute please follow these steps:
+
+- Fork the repurpose repository to your account
+- make a new feature branch from the repurpose master branch
+- Add your feature
+- Please include tests for your contributions in one of the test directories.
+  We use py.test so a simple function called test_my_feature is enough
+- submit a pull request to our master branch
+
 Note
 ====