best-readme-template
best-readme-template copied to clipboard
krvaibhaw
An awesome README template you will ever need to jumpstart your projects!
Best-README-Template
An awesome README template to jumpstart your projects!
Explore the docs »
Report Bug
·
Request Feature
Table of Contents
-
About The Project
- Built With
- Live Demo
-
Getting Started
- Prerequisites
- Installation
- Usage
- Roadmap
- Contributing
- License
- Contact
- Acknowledgements
About The Project
A README file contains information about other files in a directory or archive of computer software. A form of documentation, it is usually a simple plain text file. There are many great README templates available on GitHub, but I think that this README template is so amazing that it'll be the last one you ever need -- I think this is it.
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 :smile:
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. I hope this reource is helpful for you in the process of building an ultimate README page for your project.
Built With
This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Mention details about :
- Major languages
- Frameworks
- Technologies used
Here are a few examples.
Live Demo
This section should list websites or platform links which live demonstrate the your project built. Leave any add-ons/plugins for the acknowledgements section.
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.
- requirements
npm install npm@latest -g
Installation
- 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.jsconst 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 greatly 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
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
krvaibhaw