Merge pull request #14 from S-Stanley/9-add-main-readme

doc: add main readme #9

README.md

@@ -0,0 +1,27 @@
+# Purpev
+
+### Introduction
+
+Welcome to purpev, an open source projet to add some gamifications.
+
+The goal is to count the number of merges request, have a grade/rank and get somes reports.
+
+You can have some data like this in gitlab or github, but they are mainly based on commit, not on merge/pull request.
+
+### Scope
+
+For the moment purpev is only working on gitlab.
+
+### Structure of the repository
+
+```services/``` crud for the database
+
+```templates/``` html pages
+
+```utils/``` OAuth2.0 connection to 3rd party like gitlab and get datas.
+
+### Stack
+
+- Flask
+- Python
+- MongoDB