Merge pull request #17 from blyndusk/feat_doc

doc(readme): #15 badges

Author: alexandre-delaloy

README.md

@@ -1,18 +1,76 @@
 # repo-template
 
+[![RELEASE](https://img.shields.io/github/v/release/blyndusk/repo-template)](https://github.com/blyndusk/repo-template/releases)
+[![RELEASE DATE](https://img.shields.io/github/release-date/blyndusk/repo-template)](https://github.com/blyndusk/repo-template/commits/main)
+[![ISSUES](https://img.shields.io/github/issues/blyndusk/repo-template)](https://github.com/blyndusk/repo-template/issues)
+[![PULL REQUESTS](https://img.shields.io/github/issues-pr/blyndusk/repo-template)](https://github.com/blyndusk/repo-template/pulls) 
+[![LAST COMMIT](https://img.shields.io/github/last-commit/blyndusk/repo-template)](https://github.com/blyndusk/repo-template/commits/main)
+[![LICENSE](https://img.shields.io/github/license/blyndusk/repo-template)](https://github.com/blyndusk/repo-template/blob/main/LICENSE) 
+[![REPO SIZE](https://img.shields.io/github/repo-size/blyndusk/repo-template)](https://github.com/blyndusk/repo-template) 
+
 [![DOCKER](https://github.com/blyndusk/repo-template/actions/workflows/docker.yml/badge.svg)](https://github.com/blyndusk/repo-template/actions/workflows/docker.yml) 
 [![PYTHON](https://github.com/blyndusk/repo-template/actions/workflows/python.yml/badge.svg)](https://github.com/blyndusk/repo-template/actions/workflows/python.yml)
 [![RELEASE](https://github.com/blyndusk/repo-template/actions/workflows/release.yml/badge.svg)](https://github.com/blyndusk/repo-template/actions/workflows/release.yml)
 
 - [repo-template](#repo-template)
-  - [Use](#use)
+  - [I - Goal](#i---goal)
+  - [II - Conventions, templates and guidelines](#ii---conventions-templates-and-guidelines)
+    - [A - Commit conventions](#a---commit-conventions)
+    - [B - Issue template](#b---issue-template)
+    - [C - Branch naming convention](#c---branch-naming-convention)
+    - [D - Pull request template](#d---pull-request-template)
+  - [III - Use](#iii---use)
+  - [IV - Project use](#iv---project-use)
     - [Help](#help)
     - [Start](#start)
     - [Stop](#stop)
     - [Restart](#restart)
     - [Display logs](#display-logs)
+  - [V - License](#v---license)
+
+## I - Goal
+
+The purpose of this repository is to provide a solid, complete and adaptable base of a quasi-virgin repository, in order to start a new project with a maximum time saving.
+
+This repository provides:
+  - commit/branch/issues/pull requests conventions, templates and guidelines
+  - GitHub Actions for CI, CD and release
+  
+
+## II - Conventions, templates and guidelines
+
+### A - Commit conventions
+
+```
+tag(scope): #issue_id message
+```
+
+See [commit_conventions.md](.github/commit_conventions.md) for more informations.
+
+### B - Issue template
+
+See [user-story.md](.github/ISSUE_TEMPLATE/user-story.md) for more informations.
 
-## Use
+### C - Branch naming convention
+
+```
+type_scope-of-the-work
+```
+
+See [branch_naming_convention.md](.github/branch_naming_convention.md) for more informations.
+
+### D - Pull request template
+
+See [user-story.md](.github/pull_request_template.md) for more informations.
+
+## III - Use
+
+Go to `New Repository`, then choose this template
+
+![create-as-tpl](./docs/create-as-tpl.jpg)
+
+
+## IV - Project use
 
 ### Help
 
@@ -44,3 +102,6 @@ $ make restart
 $ make logs
 ```
 
+## V - License
+
+Under [MIT](./LICENSE) license.