Create README.md

Lots of changes needed by yourself
2020-09-07 15:07:03 +02:00 · 2020-09-07 15:07:03 +02:00 · d56e57b342
commit d56e57b342
--- a/README.md
+++ b/README.md
@ -0,0 +1,161 @@
+<!-- PROJECT SHIELDS -->
+<!--
+*** I'm using markdown "reference style" links for readability.
+*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
+*** See the bottom of this document for the declaration of the reference variables
+*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
+*** https://www.markdownguide.org/basic-syntax/#reference-style-links
+-->
+<!--
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![MIT License][license-shield]][license-url]
+[![LinkedIn][linkedin-shield]][linkedin-url]
+-->
+
+
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+  <a href="https://github.com/paraboul/mapchecking/">
+    <img src="images/logo.png" alt="Logo" width="80" height="80">
+  </a>
+
+  <h3 align="center">Mapchecking</h3>
+
+  <p align="center">
+    This tool helps you estimate (and fact-check) the maximum number of people standing in a given area.<br />
+    <a href="https://github.com/paraboul/mapchecking/"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://www.mapchecking.com/">View Demo</a>
+    ·
+    <a href="https://github.com/paraboul/mapchecking/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/paraboul/mapchecking/issues">Request Feature</a>
+  </p>
+</p>
+
+
+
+<!-- TABLE OF CONTENTS -->
+## Table of Contents
+
+* [About the Project](#about-the-project)
+  * [Built With](#built-with)
+* [Getting Started](#getting-started)
+  * [Prerequisites](#prerequisites)
+  * [Installation](#installation)
+* [Usage](#usage)
+* [Roadmap](#roadmap)
+* [Contributing](#contributing)
+* [License](#license)
+* [Contact](#contact)
+* [Acknowledgements](#acknowledgements)
+
+
+
+## About The Project
+
+[![Product Name Screen Shot][product-screenshot]](https://example.com)
+
+Sometimes people throw out impossible numbers for attendants in an arrea and this non-profit and open-source-project helps you estimate (and fact-check) the maximum number of people standing in a given area.
+
+### Built With(FIXME)
+
+<!-- This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.-->
+
+* [Bootstrap](https://getbootstrap.com)
+* [JQuery](https://jquery.com)
+* [Laravel](https://laravel.com)
+
+
+## Getting Started
+
+To get a local copy up and running follow these simple example steps.
+
+### Prerequisites
+
+This is an example of how to list things you need to use the software and how to install them.
+* npm
+```sh
+npm install npm@latest -g
+```
+
+### Installation
+
+1. Get a free API Key at [https://example.com](https://example.com)
+2. Clone the repo
+```sh
+git clone https://github.com/your_username_/Project-Name.git
+```
+3. Install NPM packages
+```sh
+npm install
+```
+4. Enter your API in `config.js`
+```JS
+const API_KEY = 'ENTER YOUR API';
+```
+
+
+## Usage
+
+Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
+
+[Place du Trocadero](https://www.mapchecking.com/#48.8633738,2.2854191;48.8631091,2.2853869;48.8630068,2.2860521;48.8626644,2.2862560;48.8624492,2.2865296;48.8622798,2.2868353;48.8624315,2.2875059;48.8628727,2.2881335;48.8631162,2.2881657;48.8633385,2.2889328;48.8636349,2.2888470;48.8634055,2.2881013;48.8635855,2.2878868;48.8639278,2.2880209;48.8641113,2.2877044;48.8637443,2.2874952;48.8637514,2.2871787;48.8637620,2.2870124;48.8641149,2.2869051;48.8641396,2.2866368;48.8638608,2.2866798;48.8636861,2.2867280;48.8636243,2.2866154;48.8639984,2.2860092;48.8637673,2.2857490;48.8633385,2.2862023;3;48.8628950,2.2869780,18)
+[Place de la République](https://www.mapchecking.com/#48.8679577,2.3620069;48.8686247,2.3630261;48.8678431,2.3644155;48.8670403,2.3657298;48.8663133,2.3647749;2;48.8674399,2.3638984,18)
+
+## Roadmap
+
+See the [open issues](https://github.com/paraboul/mapchecking/issues) for a list of proposed features (and known issues).
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+1. Fork the Project
+2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
+3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
+4. Push to the Branch (`git push origin feature/AmazingFeature`)
+5. Open a Pull Request
+
+## License(FIXME)
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+## Contact
+
+Anthony Catel - [@paraboul](https://twitter.com/paraboul) - email@example.com(FIXME)
+
+Project Link: [https://github.com/paraboul/mapchecking/](https://github.com/paraboul/mapchecking/)
+
+
+## Acknowledgements
+* [Img Shields](https://shields.io)
+* [Choose an Open Source License](https://choosealicense.com)
+
+
+
+
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+<!--
+[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=flat-square
+[contributors-url]: https://github.com/paraboul/mapchecking/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=flat-square
+[forks-url]: https://github.com/paraboul/mapchecking/network/members
+[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=flat-square
+[stars-url]: https://github.com/paraboul/mapchecking/stargazers
+[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=flat-square
+[issues-url]: https://github.com/paraboul/mapchecking/issues
+[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=flat-square
+[license-url]: https://github.com/paraboul/mapchecking/blob/master/LICENSE.txt
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
+[linkedin-url]: https://linkedin.com/in/othneildrew
+[product-screenshot]: images/screenshot.png
+-->