Merge pull request #24 from Roslund/readme

Added README

README.md

@@ -1 +1,17 @@
 #  Sequor
+A frontend application, part of a project that aims to classify the distance traveled and the public transportation means used by commuters. This application is responsible for data collection and limited data pre-processing. The data is then analyzed on a backend application.
+
+## Gamification
+To encourage use of the application, commuters are awarded coupons for saving CO2 by taking public transport. As additional gamification, the CO2 saved is represented by a growing tree. The tree is initially a sapling and grows as the user saves CO2 by tracking trips. The tree will continuously grow when CO2 is saved until eventually, a coupon appears. This means that it wouldn’t be disruptive for the user if the amount of CO2 needed for the coupons is changed relative to usage.
+
+Seeing your tree grow would hopefully be fun in of itself and could serve to motivate more people to use the application, and possibly even those who aren’t motivated to use it just for earning coupons.
+
+![Interface Mockup](https://user-images.githubusercontent.com/3624210/69255480-2e7c2f80-0bb8-11ea-818b-db6965d4b555.png)
+
+
+## Documentation
+The application is documented using documentation comments in the code. 
+The documentation for the important parts of the application have been generated using [jazzy](https://github.com/realm/jazzy)  and is available at [https://roslund.github.io/sequor/](https://roslund.github.io/sequor/)
+
+## License
+This project is released under the GNU General Public License v3.0.

docs/index.html

@@ -69,10 +69,26 @@
 
             <h1 id='sequor' class='heading'>Sequor</h1>
 
+<p>A frontend application, part of a project that aims to classify the distance traveled and the public transportation means used by commuters. This application is responsible for data collection and limited data pre-processing. The data is then analyzed on a backend application.</p>
+<h2 id='gamification' class='heading'>Gamification</h2>
+
+<p>To encourage use of the application, commuters are awarded coupons for saving CO2 by taking public transport. As additional gamification, the CO2 saved is represented by a growing tree. The tree is initially a sapling and grows as the user saves CO2 by tracking trips. The tree will continuously grow when CO2 is saved until eventually, a coupon appears. This means that it wouldn’t be disruptive for the user if the amount of CO2 needed for the coupons is changed relative to usage.</p>
+
+<p>Seeing your tree grow would hopefully be fun in of itself and could serve to motivate more people to use the application, and possibly even those who aren’t motivated to use it just for earning coupons.</p>
+
+<p><img src="https://user-images.githubusercontent.com/3624210/69255480-2e7c2f80-0bb8-11ea-818b-db6965d4b555.png" alt="Interface Mockup"></p>
+<h2 id='documentation' class='heading'>Documentation</h2>
+
+<p>The application is documented using documentation comments in the code. 
+The documentation for the important parts of the application have been generated using <a href="https://github.com/realm/jazzy">jazzy</a>  and is available at <a href="https://roslund.github.io/sequor/">https://roslund.github.io/sequor/</a></p>
+<h2 id='license' class='heading'>License</h2>
+
+<p>This project is released under the GNU General Public License v3.0.</p>
+
           </section>
         </section>
         <section id="footer">
-          <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2019-11-20)</p>
+          <p>&copy; 2019 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2019-11-21)</p>
           <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.12.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
         </section>
       </article>