From bacdb1154ca3fd5bb68a6f827c0c5c15d3c845fc Mon Sep 17 00:00:00 2001 From: Othneil Drew Date: Sun, 22 Nov 2020 18:02:06 -0600 Subject: [PATCH] Sync file changes with blank readme --- BLANK_README.md | 91 +++++++++++++++++++++++++++++++------------------ 1 file changed, 57 insertions(+), 34 deletions(-) diff --git a/BLANK_README.md b/BLANK_README.md index 4f149f0..be4d13e 100644 --- a/BLANK_README.md +++ b/BLANK_README.md @@ -1,3 +1,15 @@ + + @@ -33,15 +45,15 @@
-

+

Logo -

YOUR_TITLE

+

project_title

-

- YOUR_SHORT_DESCRIPTION +

+ project_description
Explore the docs ยป
@@ -57,19 +69,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. +
+
@@ -80,7 +103,7 @@ Here's a blank template to get started: **To avoid retyping too much info. Do a search and replace with your text editor for the following:** -`github_username`, `repo_name`, `twitter_handle`, `email` +`github_username`, `repo_name`, `twitter_handle`, `email`, `project_title`, `project_description` ### Built With @@ -100,20 +123,20 @@ To get a local copy up and running follow these simple 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. Clone the repo -```sh -git clone https://github.com/github_username/repo_name.git -``` + ```sh + git clone https://github.com/github_username/repo_name.git + ``` 2. Install NPM packages -```sh -npm install -``` + ```sh + npm install + ``` @@ -175,16 +198,16 @@ Project Link: [https://github.com/github_username/repo_name](https://github.com/ -[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo.svg?style=flat-square +[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo.svg?style=for-the-badge [contributors-url]: https://github.com/github_username/repo/graphs/contributors -[forks-shield]: https://img.shields.io/github/forks/github_username/repo.svg?style=flat-square +[forks-shield]: https://img.shields.io/github/forks/github_username/repo.svg?style=for-the-badge [forks-url]: https://github.com/github_username/repo/network/members -[stars-shield]: https://img.shields.io/github/stars/github_username/repo.svg?style=flat-square +[stars-shield]: https://img.shields.io/github/stars/github_username/repo.svg?style=for-the-badge [stars-url]: https://github.com/github_username/repo/stargazers -[issues-shield]: https://img.shields.io/github/issues/github_username/repo.svg?style=flat-square +[issues-shield]: https://img.shields.io/github/issues/github_username/repo.svg?style=for-the-badge [issues-url]: https://github.com/github_username/repo/issues -[license-shield]: https://img.shields.io/github/license/github_username/repo.svg?style=flat-square +[license-shield]: https://img.shields.io/github/license/github_username/repo.svg?style=for-the-badge [license-url]: https://github.com/github_username/repo/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/github_username [product-screenshot]: images/screenshot.png