diff --git a/README.md b/README.md index 72eb5e9..0ac9deb 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,12 @@ - -
-

+

Logo -

Best-README-Template

+

Best-README-Template

-

+

An awesome README template to jumpstart your projects!
Explore the docs ยป @@ -52,19 +50,30 @@ -## 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) +

+

Table of Contents

+
    +
  1. + About The Project + +
  2. +
  3. + Getting Started + +
  4. +
  5. Usage
  6. +
  7. Roadmap
  8. +
  9. Contributing
  10. +
  11. License
  12. +
  13. Contact
  14. +
  15. Acknowledgements
  16. +
+
@@ -73,18 +82,19 @@ [![Product Name Screen Shot][product-screenshot]](https://example.com) -There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need. +There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it. Here's why: * Your time should be focused on creating something amazing. A project that solves a problem and helps others * You shouldn't be doing the same tasks over and over like creating a README from scratch * You should element DRY principles to the rest of your life :smile: -Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. +Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have have contributed to expanding this template! A list of commonly used resources that I find helpful are listed in the acknowledgements. ### Built With + 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) @@ -102,25 +112,25 @@ To get a local copy up and running follow these simple example steps. 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 -``` + ```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 -``` + ```sh + git clone https://github.com/your_username_/Project-Name.git + ``` 3. Install NPM packages -```sh -npm install -``` + ```sh + npm install + ``` 4. Enter your API in `config.js` -```JS -const API_KEY = 'ENTER YOUR API'; -``` + ```JS + const API_KEY = 'ENTER YOUR API'; + ``` @@ -189,16 +199,16 @@ Project Link: [https://github.com/your_username/repo_name](https://github.com/yo -[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=flat-square +[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge [contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors -[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=flat-square +[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge [forks-url]: https://github.com/othneildrew/Best-README-Template/network/members -[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=flat-square +[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge [stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers -[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=flat-square +[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge [issues-url]: https://github.com/othneildrew/Best-README-Template/issues -[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=flat-square +[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge [license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt -[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 [linkedin-url]: https://linkedin.com/in/othneildrew [product-screenshot]: images/screenshot.png