Read Me Template
A Read Me template for your projects!
Explore the docs Β»
View Demo
Β·
Report Bug
Β·
Request Feature
Β·
Send a Pull Request
About The Project
![Product Name Screen Shot][product-screenshot]
There are many great README templates available on GitHub, however, I didn't find one that really suited 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.
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
π
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.
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.
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
npm install npm@latest -gInstallation
- Get a free API Key at https://example.com
- Clone the repo
git clone https://github.com/your_username_/Project-Name.git- Install NPM packages
npm install- Enter your API in
config.js
const API_KEY = 'ENTER YOUR API';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
π§ Roadmap
See the open issues for a list of proposed features (and known issues).
π€ Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are extremely appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
π License
Describe your License for your project.
Distributed under the MIT License. See LICENSE for more information.
π« Contact
Your Name - @your_twitter - [email protected]
Project Link: https://github.com/your_username/repo_name
Acknowledgements
- Img Shields
- GitHub Pages
- Font Awesome
- blah blah blah....