Adds basic docs (#44)

* Adds basic docs

Author: dkastl

README.md

@@ -41,9 +41,11 @@ More information on installing (and uninstalling) Redmine plugins can be found h
 - Make sure REST web services is enabled: http://localhost:3000/settings?tab=api
 - Enable the plugin in project settings
 
-The Geo-Task-Tracker (GTT) S.M.A.S.H plugin is connects the S.M.A.S.H mobile app with Redmine GTT. 
+The Geo-Task-Tracker (GTT) S.M.A.S.H plugin connects the S.M.A.S.H mobile app with Redmine GTT. 
 It adds new API endpoints to provide the tracker type configuration as custom notes. 
 
+For more information with screenshots see the [Getting Started](doc/getting-started.md) guide.
+
 **Project level API endpoint** 
 
 ```

doc/getting-started.md

@@ -0,0 +1,61 @@
+# Getting Started with GTT SMASH plugin
+
+The **Redmine GTT SMASH** plugin allows you to connect your [Redmine GTT](https://gtt-project.org/) projects with the [SMASH mobile app](https://www.geopaparazzi.org/smash/index.html) to create field notes and upload them as issues to [Redmine](https://redmine.org/).
+
+SMASH is a digital field mapping application developed to perform fast qualitative engineering/geologic surveys and GIS data collection.
+
+## Installing SMASH
+
+You can install the SMASH app from the app stores:
+
+* *SMASH Digital field mapping* for iOS devices on the [Apple store](https://apps.apple.com/us/app/smash-digital-field-mapping/id1475079936).
+* *SMASH field mapping* for Android devices on the [Google Play store](https://play.google.com/store/apps/details?id=eu.hydrologis.smash&hl=en).
+
+The following plugin documentation gives a brief introduction in how to use SMASH with Redmine.
+
+SMASH provides additional functionality that is available in the [SMASH User Manual](https://www.geopaparazzi.org/smash/index.html).
+
+## Integration in Redmine GTT
+
+To get projects connected with SMASH mobile application make sure to enable the **GTT SMASH** module in your Redmine project settings.
+
+![Project Modules](project_modules.png)
+
+## Connect SMASH mobile application to Redmine
+
+### Connect Redmine account
+
+In SMASH mobile application top menu go to **Export** or **Import**. Click on the gear icon of **GTT** and you will see the following:
+
+![GTT URL](import_setting.png) ![GTT URL](gtt_url.png)
+
+* **Server URL**: enter your Redmine URL `example.com`
+* **Server Username**: your Redmine account's `username`
+* **Server Password**: your Redmine account's `password`
+
+### Import Redmine projects
+
+In menu again go to **Import** → **GTT** → Select Project → Click **Import**
+
+![GTT Import](gtt_import.png)
+
+This will import your project's form configuration to mobile storage.
+
+### Create issue
+
+In SMASH application you can create Simple Notes, Form Notes, etc. Form Notes can be exported to your Redmine project as **issue**.
+
+:::caution
+Only *Form Notes* are currently supported in combination with Redmine GTT!
+:::
+
+Follow these steps to upload your notes as issues or synchronize changes:
+
+1. Go to top menu **Export** → **GTT**
+2. It will inidicate if there is new data to be uploaded
+3. Choose a project for creating the issue(s)
+4. Click on **Upload** to export the issue(s)
+
+![GTT Export](gtt_export.png)
+
+Your issues will be created (or updated) in the specified project.