docs: Update README.md

README.md

@@ -1 +1,33 @@
-This is the repository for RiskAhead-Android App
+~ What is RiskAhead?
+
+RiskAhead is your global tool to inform about violence in your vicinity and report crime anonymously.
+
+Avoid crimes, violence, natural disasters and catastrophes via warnings about attacks, vandalism, drug abuse, car robbery, thefts, shootings, sexual harassment, rape, murder, terror bombing, terrorism and further more.
+
+
+
+~ Commit message conventions
+
+Commit messages are used to generate the release notes for each release. To do this, we loosely follow the AngularJS commit conventions: for commit messages to appear in the release notes, the title line needs to respect the following format:
+
+  <type>: <message>
+where is one of the following:
+
+feat: A new feature
+fix: A bug fix
+docs: Documentation only changes
+style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+refactor: A code change that neither fixes a bug or adds a feature
+perf: A code change that improves performance
+test: Adding missing tests
+chore: Changes to the build process or auxiliary tools and libraries such as documentation generation
+Also commits can consists of several lines - to include some additional information in relase notes. For example:
+
+feat: A new feature to make something better
+now it will be available to call api.function() with additional parameters like api.function(Integer)
+it will be included in release notes as:
+
+feat: A new feature to make something better
+
+now it will be available to call api.function() with additional parameters like api.function(Integer)
+Please take a look at release notes to find some more examples of mutiline commits.