mirror of
https://github.com/othneildrew/Best-README-Template.git
synced 2026-10-12 12:16:38 +00:00
Update: add changelog; fixed typos; add roadmap checklist; add back to top link
This commit is contained in:
+54
-24
@@ -1,13 +1,10 @@
|
||||
<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
|
||||
***
|
||||
***
|
||||
***
|
||||
*** To avoid retyping too much info. Do a search and replace for the following:
|
||||
*** github_username, repo_name, twitter_handle, email, project_title, project_description, your_name, linkedin_username
|
||||
-->
|
||||
|
||||
|
||||
@@ -36,7 +33,7 @@
|
||||
<img src="images/logo.png" alt="Logo" width="80" height="80">
|
||||
</a>
|
||||
|
||||
<h3 align="center">project_title</h3>
|
||||
<h3 align="center">project_title</h3>
|
||||
|
||||
<p align="center">
|
||||
project_description
|
||||
@@ -55,7 +52,7 @@
|
||||
|
||||
|
||||
<!-- TABLE OF CONTENTS -->
|
||||
<details open="open">
|
||||
<details>
|
||||
<summary>Table of Contents</summary>
|
||||
<ol>
|
||||
<li>
|
||||
@@ -76,7 +73,7 @@
|
||||
<li><a href="#contributing">Contributing</a></li>
|
||||
<li><a href="#license">License</a></li>
|
||||
<li><a href="#contact">Contact</a></li>
|
||||
<li><a href="#acknowledgements">Acknowledgements</a></li>
|
||||
<li><a href="#acknowledgments">Acknowledgments</a></li>
|
||||
</ol>
|
||||
</details>
|
||||
|
||||
@@ -87,23 +84,32 @@
|
||||
|
||||
[![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`, `project_title`, `project_description`
|
||||
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`, `email_client`, `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
|
||||
|
||||
To get a local copy up and running follow these simple steps.
|
||||
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
|
||||
|
||||
@@ -115,14 +121,21 @@ This is an example of how to list things you need to use the software and how to
|
||||
|
||||
### Installation
|
||||
|
||||
1. Clone the repo
|
||||
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
|
||||
```
|
||||
2. Install NPM packages
|
||||
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>
|
||||
|
||||
|
||||
|
||||
@@ -133,12 +146,21 @@ Use this space to show useful examples of how a project can be used. Additional
|
||||
|
||||
_For more examples, please refer to the [Documentation](https://example.com)_
|
||||
|
||||
<p align="right">(<a href="#top">back to top</a>)</p>
|
||||
|
||||
|
||||
|
||||
<!-- ROADMAP -->
|
||||
## Roadmap
|
||||
|
||||
See the [open issues](https://github.com/github_username/repo_name/issues) for a list of proposed features (and known issues).
|
||||
- [] 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>
|
||||
|
||||
|
||||
|
||||
@@ -147,41 +169,49 @@ See the [open issues](https://github.com/github_username/repo_name/issues) for a
|
||||
|
||||
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` for more information.
|
||||
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
|
||||
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>
|
||||
|
||||
|
||||
<!-- ACKNOWLEDGEMENTS -->
|
||||
## Acknowledgements
|
||||
|
||||
<!-- ACKNOWLEDGMENTS -->
|
||||
## Acknowledgments
|
||||
|
||||
* []()
|
||||
* []()
|
||||
* []()
|
||||
|
||||
<p align="right">(<a href="#top">back to top</a>)</p>
|
||||
|
||||
|
||||
README template based on [othneildrew](https://github.com/othneildrew/Best-README-Template)
|
||||
|
||||
|
||||
<!-- MARKDOWN LINKS & IMAGES -->
|
||||
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
||||
|
||||
Reference in New Issue
Block a user