Update README.md (#11)

* Update README.md, fixes #4 

Signed-off-by: Daniel Kastl <[email protected]>

Co-authored-by: Ko Nagase <[email protected]>

Author: dkastl

README.md

@@ -1,3 +1,60 @@
-# redmine_gtt_smash
+# Redmine GTT S.M.A.S.H Plugin
+
+![CI #develop](https://github.com/gtt-project/redmine_gtt_smash/workflows/Test%20with%20Redmine/badge.svg)
+
+The Geo-Task-Tracker (GTT) S.M.A.S.H plugin adds support for the mobile app [S.M.A.S.H](https://github.com/moovida/smash):
+
+- Authenticate from S.M.A.S.H with a Redmine account
+- Upload mobile notes as issues
+- Retrieve custom notes configurations
+- and more ...
+
+## Requirements
+
+Redmine GTT S.M.A.S.H **requires PostgreSQL/PostGIS** and will not work with SQLite or MariaDB/MySQL!!!
+
+- Redmine >= 4.0.0
+- [redmine_gtt](https://github.com/gtt-project/redmine_gtt/) plugin
+
+## Installation
+
+To install Redmine GTT S.M.A.S.H plugin, download or clone this repository in your Redmine installation plugins directory!
+
+```
+cd path/to/plugin/directory
+git clone https://github.com/gtt-project/redmine_gtt_smash.git
+```
+
+Then run
+
+```
+bundle install
+bundle exec rake redmine:plugins:migrate
+```
+
+After restarting Redmine, you should be able to see the Redmine GTT SMASH plugin in the Plugins page.
+
+More information on installing (and uninstalling) Redmine plugins can be found here: http://www.redmine.org/wiki/redmine/Plugins
+
+## How to use
+
+[Settings, screenshots, etc.]
+
+## Contributing and Support
+
+The GTT Project appreciates any [contributions](https://github.com/gtt-project/.github/blob/main/CONTRIBUTING.md)! Feel free to contact us for [reporting problems and support](https://github.com/gtt-project/.github/blob/main/CONTRIBUTING.md).
+
+## Version History
+
+See [all releases](https://github.com/gtt-project/redmine_gtt_smash/releases) with release notes.
+
+## Authors
+
+- [Ko Nagase](https://github.com/sanak)
+- [Daniel Kastl](https://github.com/dkastl)
+- ... [and others](https://github.com/gtt-project/redmine_gtt_smash/graphs/contributors)
+
+## LICENSE
+
+This program is free software. See [LICENSE](LICENSE) for more information.
 
-Plugin to use SMASH with GTT