generated from CY0xZ/Best-README-Template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit b363c04
Showing
6 changed files
with
519 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,230 @@ | ||
| <div id="top"></div> | ||
| <!-- | ||
| *** Thanks for checking out the Best-README-Template. If you have a suggestion | ||
| *** that would make this better, please fork the repo and create a pull request | ||
| *** or simply open an issue with the tag "enhancement". | ||
| *** Don't forget to give the project a star! | ||
| *** Thanks again! Now go create something AMAZING! :D | ||
| --> | ||
|
|
||
|
|
||
|
|
||
| <!-- 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 /> | ||
| <div align="center"> | ||
| <a href="https://github.com/github_username/repo_name"> | ||
| <img src="images/logo.png" alt="Logo" width="80" height="80"> | ||
| </a> | ||
|
|
||
| <h3 align="center">project_title</h3> | ||
|
|
||
| <p align="center"> | ||
| project_description | ||
| <br /> | ||
| <a href="https://github.com/github_username/repo_name"><strong>Explore the docs »</strong></a> | ||
| <br /> | ||
| <br /> | ||
| <a href="https://github.com/github_username/repo_name">View Demo</a> | ||
| · | ||
| <a href="https://github.com/github_username/repo_name/issues">Report Bug</a> | ||
| · | ||
| <a href="https://github.com/github_username/repo_name/issues">Request Feature</a> | ||
| </p> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
| <details> | ||
| <summary>Table of Contents</summary> | ||
| <ol> | ||
| <li> | ||
| <a href="#about-the-project">About The Project</a> | ||
| <ul> | ||
| <li><a href="#built-with">Built With</a></li> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <a href="#getting-started">Getting Started</a> | ||
| <ul> | ||
| <li><a href="#prerequisites">Prerequisites</a></li> | ||
| <li><a href="#installation">Installation</a></li> | ||
| </ul> | ||
| </li> | ||
| <li><a href="#usage">Usage</a></li> | ||
| <li><a href="#roadmap">Roadmap</a></li> | ||
| <li><a href="#contributing">Contributing</a></li> | ||
| <li><a href="#license">License</a></li> | ||
| <li><a href="#contact">Contact</a></li> | ||
| <li><a href="#acknowledgments">Acknowledgments</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
|
|
||
|
|
||
| <!-- ABOUT THE PROJECT --> | ||
| ## About The Project | ||
|
|
||
| [![Product Name Screen Shot][product-screenshot]](https://example.com) | ||
|
|
||
| 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`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description` | ||
|
|
||
| <p align="right">(<a href="#top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| ### Built With | ||
|
|
||
| * [Next.js](https://nextjs.org/) | ||
| * [React.js](https://reactjs.org/) | ||
| * [Vue.js](https://vuejs.org/) | ||
| * [Angular](https://angular.io/) | ||
| * [Svelte](https://svelte.dev/) | ||
| * [Laravel](https://laravel.com) | ||
| * [Bootstrap](https://getbootstrap.com) | ||
| * [JQuery](https://jquery.com) | ||
|
|
||
| <p align="right">(<a href="#top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- GETTING STARTED --> | ||
| ## Getting Started | ||
|
|
||
| This is an example of how you may give instructions on setting up your project locally. | ||
| 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/github_username/repo_name.git | ||
| ``` | ||
| 3. Install NPM packages | ||
| ```sh | ||
| npm install | ||
| ``` | ||
| 4. Enter your API in `config.js` | ||
| ```js | ||
| const API_KEY = 'ENTER YOUR API'; | ||
| ``` | ||
|
|
||
| <p align="right">(<a href="#top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- USAGE EXAMPLES --> | ||
| ## 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. | ||
|
|
||
| _For more examples, please refer to the [Documentation](https://example.com)_ | ||
|
|
||
| <p align="right">(<a href="#top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- ROADMAP --> | ||
| ## Roadmap | ||
|
|
||
| - [ ] Feature 1 | ||
| - [ ] Feature 2 | ||
| - [ ] Feature 3 | ||
| - [ ] Nested Feature | ||
|
|
||
| See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues). | ||
|
|
||
| <p align="right">(<a href="#top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- CONTRIBUTING --> | ||
| ## Contributing | ||
|
|
||
| Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**. | ||
|
|
||
| If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". | ||
| Don't forget to give the project a star! Thanks again! | ||
|
|
||
| 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 | ||
|
|
||
| <p align="right">(<a href="#top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- LICENSE --> | ||
| ## License | ||
|
|
||
| Distributed under the MIT License. See `LICENSE.txt` for more information. | ||
|
|
||
| <p align="right">(<a href="#top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- CONTACT --> | ||
| ## Contact | ||
|
|
||
| Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com | ||
|
|
||
| Project Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name) | ||
|
|
||
| <p align="right">(<a href="#top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- ACKNOWLEDGMENTS --> | ||
| ## Acknowledgments | ||
|
|
||
| * []() | ||
| * []() | ||
| * []() | ||
|
|
||
| <p align="right">(<a href="#top">back to top</a>)</p> | ||
|
|
||
|
|
||
|
|
||
| <!-- MARKDOWN LINKS & IMAGES --> | ||
| <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --> | ||
| [contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge | ||
| [contributors-url]: https://github.com/github_username/repo_name/graphs/contributors | ||
| [forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge | ||
| [forks-url]: https://github.com/github_username/repo_name/network/members | ||
| [stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge | ||
| [stars-url]: https://github.com/github_username/repo_name/stargazers | ||
| [issues-shield]: https://img.shields.io/github/issues/github_username/repo_name.svg?style=for-the-badge | ||
| [issues-url]: https://github.com/github_username/repo_name/issues | ||
| [license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge | ||
| [license-url]: https://github.com/github_username/repo_name/blob/master/LICENSE.txt | ||
| [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 | ||
| [linkedin-url]: https://linkedin.com/in/linkedin_username | ||
| [product-screenshot]: images/screenshot.png |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| # Changelog | ||
|
|
||
| ## v1.0.0 | ||
|
|
||
| ### Added or Changed | ||
| - Added this changelog :) | ||
| - Fixed typos in both templates | ||
| - Back to top links | ||
| - Added more "Built With" frameworks/libraries | ||
| - Changed table of contents to start collapsed | ||
| - Added checkboxes for major features on roadmap | ||
|
|
||
| ### Removed | ||
|
|
||
| - Some packages/libraries from acknowledgements I no longer use |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2021 Othneil Drew | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
Oops, something went wrong.