Showing
1 changed file
with
190 additions
and
0 deletions
README.md
0 → 100644
| 1 | +<!-- | ||
| 2 | +*** Thanks for checking out this README Template. If you have a suggestion that would | ||
| 3 | +*** make this better, please fork the repo and create a pull request or simply open | ||
| 4 | +*** an issue with the tag "enhancement". | ||
| 5 | +*** Thanks again! Now go create something AMAZING! :D | ||
| 6 | +*** | ||
| 7 | +*** | ||
| 8 | +*** | ||
| 9 | +*** To avoid retyping too much info. Do a search and replace for the following: | ||
| 10 | +*** github_username, repo, twitter_handle, email | ||
| 11 | +--> | ||
| 12 | + | ||
| 13 | + | ||
| 14 | + | ||
| 15 | + | ||
| 16 | + | ||
| 17 | +<!-- PROJECT SHIELDS --> | ||
| 18 | +<!-- | ||
| 19 | +*** I'm using markdown "reference style" links for readability. | ||
| 20 | +*** Reference links are enclosed in brackets [ ] instead of parentheses ( ). | ||
| 21 | +*** See the bottom of this document for the declaration of the reference variables | ||
| 22 | +*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use. | ||
| 23 | +*** https://www.markdownguide.org/basic-syntax/#reference-style-links | ||
| 24 | +--> | ||
| 25 | +[![Contributors][contributors-shield]][contributors-url] | ||
| 26 | +[![Forks][forks-shield]][forks-url] | ||
| 27 | +[![Stargazers][stars-shield]][stars-url] | ||
| 28 | +[![Issues][issues-shield]][issues-url] | ||
| 29 | +[![MIT License][license-shield]][license-url] | ||
| 30 | +[![LinkedIn][linkedin-shield]][linkedin-url] | ||
| 31 | + | ||
| 32 | + | ||
| 33 | + | ||
| 34 | +<!-- PROJECT LOGO --> | ||
| 35 | +<br /> | ||
| 36 | +<p align="center"> | ||
| 37 | + <a href="https://github.com/github_username/repo"> | ||
| 38 | + <img src="images/logo.png" alt="Logo" width="80" height="80"> | ||
| 39 | + </a> | ||
| 40 | + | ||
| 41 | + <h3 align="center">YOUR_TITLE</h3> | ||
| 42 | + | ||
| 43 | + <p align="center"> | ||
| 44 | + YOUR_SHORT_DESCRIPTION | ||
| 45 | + <br /> | ||
| 46 | + <a href="https://github.com/github_username/repo"><strong>Explore the docs »</strong></a> | ||
| 47 | + <br /> | ||
| 48 | + <br /> | ||
| 49 | + <a href="https://github.com/github_username/repo">View Demo</a> | ||
| 50 | + · | ||
| 51 | + <a href="https://github.com/github_username/repo/issues">Report Bug</a> | ||
| 52 | + · | ||
| 53 | + <a href="https://github.com/github_username/repo/issues">Request Feature</a> | ||
| 54 | + </p> | ||
| 55 | +</p> | ||
| 56 | + | ||
| 57 | + | ||
| 58 | + | ||
| 59 | +<!-- TABLE OF CONTENTS --> | ||
| 60 | +## Table of Contents | ||
| 61 | + | ||
| 62 | +* [About the Project](#about-the-project) | ||
| 63 | + * [Built With](#built-with) | ||
| 64 | +* [Getting Started](#getting-started) | ||
| 65 | + * [Prerequisites](#prerequisites) | ||
| 66 | + * [Installation](#installation) | ||
| 67 | +* [Usage](#usage) | ||
| 68 | +* [Roadmap](#roadmap) | ||
| 69 | +* [Contributing](#contributing) | ||
| 70 | +* [License](#license) | ||
| 71 | +* [Contact](#contact) | ||
| 72 | +* [Acknowledgements](#acknowledgements) | ||
| 73 | + | ||
| 74 | + | ||
| 75 | + | ||
| 76 | +<!-- ABOUT THE PROJECT --> | ||
| 77 | +## About The Project | ||
| 78 | + | ||
| 79 | +[![Product Name Screen Shot][product-screenshot]](https://example.com) | ||
| 80 | + | ||
| 81 | +Here's a blank template to get started: | ||
| 82 | +**To avoid retyping too much info. Do a search and replace with your text editor for the following:** | ||
| 83 | +`github_username`, `repo`, `twitter_handle`, `email` | ||
| 84 | + | ||
| 85 | + | ||
| 86 | +### Built With | ||
| 87 | + | ||
| 88 | +* []() | ||
| 89 | +* []() | ||
| 90 | +* []() | ||
| 91 | + | ||
| 92 | + | ||
| 93 | + | ||
| 94 | +<!-- GETTING STARTED --> | ||
| 95 | +## Getting Started | ||
| 96 | + | ||
| 97 | +To get a local copy up and running follow these simple steps. | ||
| 98 | + | ||
| 99 | +### Prerequisites | ||
| 100 | + | ||
| 101 | +This is an example of how to list things you need to use the software and how to install them. | ||
| 102 | +* npm | ||
| 103 | +```sh | ||
| 104 | +npm install npm@latest -g | ||
| 105 | +``` | ||
| 106 | + | ||
| 107 | +### Installation | ||
| 108 | + | ||
| 109 | +1. Clone the repo | ||
| 110 | +```sh | ||
| 111 | +git clone https://github.com/github_username/repo.git | ||
| 112 | +``` | ||
| 113 | +2. Install NPM packages | ||
| 114 | +```sh | ||
| 115 | +npm install | ||
| 116 | +``` | ||
| 117 | + | ||
| 118 | + | ||
| 119 | + | ||
| 120 | +<!-- USAGE EXAMPLES --> | ||
| 121 | +## Usage | ||
| 122 | + | ||
| 123 | +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. | ||
| 124 | + | ||
| 125 | +_For more examples, please refer to the [Documentation](https://example.com)_ | ||
| 126 | + | ||
| 127 | + | ||
| 128 | + | ||
| 129 | +<!-- ROADMAP --> | ||
| 130 | +## Roadmap | ||
| 131 | + | ||
| 132 | +See the [open issues](https://github.com/github_username/repo/issues) for a list of proposed features (and known issues). | ||
| 133 | + | ||
| 134 | + | ||
| 135 | + | ||
| 136 | +<!-- CONTRIBUTING --> | ||
| 137 | +## Contributing | ||
| 138 | + | ||
| 139 | +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**. | ||
| 140 | + | ||
| 141 | +1. Fork the Project | ||
| 142 | +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) | ||
| 143 | +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) | ||
| 144 | +4. Push to the Branch (`git push origin feature/AmazingFeature`) | ||
| 145 | +5. Open a Pull Request | ||
| 146 | + | ||
| 147 | + | ||
| 148 | + | ||
| 149 | +<!-- LICENSE --> | ||
| 150 | +## License | ||
| 151 | + | ||
| 152 | +Distributed under the MIT License. See `LICENSE` for more information. | ||
| 153 | + | ||
| 154 | + | ||
| 155 | + | ||
| 156 | +<!-- CONTACT --> | ||
| 157 | +## Contact | ||
| 158 | + | ||
| 159 | +Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email | ||
| 160 | + | ||
| 161 | +Project Link: [https://github.com/github_username/repo](https://github.com/github_username/repo) | ||
| 162 | + | ||
| 163 | + | ||
| 164 | + | ||
| 165 | +<!-- ACKNOWLEDGEMENTS --> | ||
| 166 | +## Acknowledgements | ||
| 167 | + | ||
| 168 | +* []() | ||
| 169 | +* []() | ||
| 170 | +* []() | ||
| 171 | + | ||
| 172 | + | ||
| 173 | + | ||
| 174 | + | ||
| 175 | + | ||
| 176 | +<!-- MARKDOWN LINKS & IMAGES --> | ||
| 177 | +<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
| 178 | +[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=flat-square | ||
| 179 | +[contributors-url]: https://github.com/othneildrew/Best-README-Template/graphs/contributors | ||
| 180 | +[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=flat-square | ||
| 181 | +[forks-url]: https://github.com/othneildrew/Best-README-Template/network/members | ||
| 182 | +[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=flat-square | ||
| 183 | +[stars-url]: https://github.com/othneildrew/Best-README-Template/stargazers | ||
| 184 | +[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=flat-square | ||
| 185 | +[issues-url]: https://github.com/othneildrew/Best-README-Template/issues | ||
| 186 | +[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=flat-square | ||
| 187 | +[license-url]: https://github.com/othneildrew/Best-README-Template/blob/master/LICENSE.txt | ||
| 188 | +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 | ||
| 189 | +[linkedin-url]: https://linkedin.com/in/othneildrew | ||
| 190 | +[product-screenshot]: images/screenshot.png |
-
Please register or login to post a comment