Merge pull request #11 from romainfb/Feat/readMe

This commit implements content in README file

README.md

@@ -1 +1,48 @@
-*Initial readme*
+# Bordeaux WC
+## _View public WC in Bordeaux - **Versionning** project_
+
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![made-with-javascript](https://img.shields.io/badge/Made%20with-JavaScript-1f425f.svg)](https://www.javascript.com) [![Awesome](https://awesome.re/badge.svg)](https://romainfb.github.io/bordeauxwc/)
+
+BordeauxWC is a student project designed by Romain F and Yanis S, two B3 development students at Sup de Vinci Bordeaux. This site is the result of a project in our **versioning course**, aimed at applying our theoretical knowledge in a practical context. BordeauxWC uses Bordeaux Métropole's open API to list the city's public sanitation facilities.
+
+## Website
+https://romainfb.github.io/bordeauxwc/
+
+## Useful links - Project
+Project objectives: https://github.com/users/romainfb/projects/3
+
+Project technical requirements: https://github.com/users/romainfb/projects/4
+
+## Project objectives
+
+| Objective     | Achieved |
+| ------------- | ------------- |
+| Create a GitHub repository  | Done!  |
+| Configure it for both group members.  | Done!  |
+|Use the development workflow of your choice | Done!|
+|Create a static, techno, open-source website. |Done!|
+|At least 3 PR/MRs are needed within the "finished" project.|Done!|
+|Commit messages and branch names must follow a specific nomenclature|Done!|
+|The repository must be accompanied by a Wiki, which contains the rules for in place (workflow chosen, nomenclature rules, etc.).|Done!|
+|The repository must be accompanied by a project, containing several issues.|Done!|
+|Some issues must be linked to PRs (and therefore closed if the PR is validated).|Done!|
+|The repository must include scanning for secrets and dependabots.|Done!|
+|Templates are required for issues and PRs.|Done!|
+|The recommendations of the Community Standards tab must be applied.|Done!|
+
+| Bonus     | Achieved |
+| ------------- | ------------- |
+| If Dependabot and secret scanning have found any errors  | In progress  |
+| If the static site is complete (has at least 3 pages with navigation)  | Done!  |
+|Protect main branch from PR/PM| Done!|
+
+## Demo
+
+![alt text](https://cdn.discordapp.com/attachments/290407097747898368/1175836332933787768/Design_sans_titre.png?ex=656cadeb&is=655a38eb&hm=6c6e152c3b5078a947ff32a17cce0fa43ba98c57b29f3e390eea5f5844899edc&)
+
+## Contributors
+
+| Contributors list     |
+| ------------- |
+|[@romainfb](https://github.com/romainfb)|
+|[@SaidiYanis](https://github.com/SaidiYanis) |