From 9388dfae50d7142120416d5a5df2ed2662bb9923 Mon Sep 17 00:00:00 2001
From: Stefan Hendricks <stefan.hendricks@awi.de>
Date: Mon, 12 Jul 2021 14:44:26 +0200
Subject: [PATCH] Update readmes

---
 README.md  |  3 ---
 README.rst | 44 ++++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 42 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 1cf9543..e69de29 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +0,0 @@
-# FloeNavi Toolbox
-
-Python toolbox for managing and transforming GPS positions into the FloeNavi Coordinate Reference System (FloeNavi CRS). Depends on icedrift
\ No newline at end of file
diff --git a/README.rst b/README.rst
index 97cd3fa..bb8cc98 100644
--- a/README.rst
+++ b/README.rst
@@ -1,3 +1,43 @@
-FloeNavi
-========
+FloeNavi Toolbox
+################
+
+Python toolbox for managing and transforming GPS positions for measurements into a cartesian coordinate system anchored in drifting sea ice using a reference station. The toolbox was created for the Multidisciplinary drifting Observatory for the Study of Arctic Climate (MOSAiC), but can be used with any source of reference data. 
+
+The toolbox has built-in supports two source of reference sources: 
+
+1. Polarstern position and heading 
+2. MOSAiC floenavi virtual reference station
+
+**Requirements**:
+
+Zhe toolbox is based on python 3 and has been tested until python 3.7 version so far. In addition to standard python packages it uses the `icedrift <https://gitlab.awi.de/floenavi-crs/icedrift/>`_ package for the coordinate transformation. 
+
+**Installation**:
+  
+The python uses standard python package conventions and can be installed with pip directly from the git repository:
+
+.. code-block::
+    
+  pip install https://gitlab.awi.de/floenavi-crs/floenavi.git
+
+
+**Examples**:
+
+Using the floenavi toolbox with: 
+
+1. `floenavi basestation data <https://gitlab.awi.de/floenavi-crs/floenavi/-/blob/master/examples/mosaic-floenavi-example.ipynb?expanded=true&viewer=rich>`_
+   
+2. `polarstern reference data <https://gitlab.awi.de/floenavi-crs/floenavi/-/blob/master/examples/mosaic-polarstern-refstat-example.ipynb?expanded=true&viewer=rich>`_
+
+**Citation**: 
+
+FloeNavi toolbox 1.0.2 (https://gitlab.awi.de/floenavi-crs), Stefan Hendricks, Alfred Wegener Institute Helmholtz Center for Polar and Marine Research (DATE OF LAST ACCESS). 
+  
+
+
+
+
+
+
+
 
-- 
GitLab