Update documentation

README.rst

@@ -1,29 +1,67 @@
 .. _start-intro:
-====================================
-PyFields - A fields analysis package
-====================================
-..
-   .. image:: https://gitlab.com/gitlab-org/gitlab-ce/badges/master/build.svg
-      :target: https://gitlab.com/gabylaunay/IMTreatment/commits/master
-      :alt: Build status
-   .. image:: https://gitlab.com/gitlab-org/gitlab-ce/badges/master/coverage.svg
-      :target: https://framagit.org/gabylaunay/IMTreatment/pipelines
-      :alt: Overall test coverage
-   .. image:: https://readthedocs.org/projects/imtreatment/badge/?version=latest
-      :target: http://imtreatment.readthedocs.io/en/latest/?badge=latest
-      :alt: Documentation Status
-
-
-This module has been written to carry out analysis on 2D and 3D fields,
+
+.. image:: https://travis-ci.org/galaunay/PyFields.svg?branch=master
+    :target: https://travis-ci.org/galaunay/PyFields
+    :alt: Build status
+.. image:: https://coveralls.io/repos/github/galaunay/PyFields/badge.svg?branch=master
+    :target: https://coveralls.io/github/galaunay/PyFields?branch=master
+    :alt: Overall test coverage
+.. image:: https://readthedocs.org/projects/PyFields/badge/?version=latest
+    :target: http://PyFields.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+==============================================
+PyFields - 2D and 3D Fields Analysis in Python
+==============================================
+
+PyFields is a Python3 package, intending to ease the manipulation and analysis of 2D and 3D fields,
 like velocity, concentration, temperature, ... .
+
 It can handle sets of fields, to analyze time evolution of the aforementioned fields.
-This module includes methods for importing field, analysing them, display them and export them in other format.
+It includes easy-to-use helpers for importing field, analysing them, display them and export them in other format.
 
-This project is hosted on Github_.
+Documentation
+=============
 
 Full documentation is available on ReadTheDocs_.
 
-.. _Github: https://github.com/galaunay/PyFields
 .. _ReadTheDocs:
 
+Installation
+============
+
+Just run:
+
+.. code-block:: sh
+
+   python setup.py install
+
+You can run the tests with:
+
+.. code-block:: sh
+
+   python setup.py pytest
+
+Report/contribute
+======================
+
+PyFields is hosted on Github_, you can report an issue_, ask your questions_ or contribute_ to this project there.
+
+.. _Github: https://github.com/galaunay/PyFields
+
+.. _issue: https://github.com/galaunay/PyFields/issues
+
+.. _questions: https://github.com/galaunay/PyFields/issues
+
+.. _contribute: https://github.com/galaunay/PyFields/pulls
+
+License
+=======
+
+This project is free software: You can redistribute it and/or modify
+it under the terms of the `GNU General Public License`__, either
+version 3 of the License, or (at your option) any later version.
+
+.. __: LICENSE
+
 .. _end-intro: