ADD_DESCRIPTION_HERE
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
- About the Project
- Getting Started
- Versioning
- Roadmap
- Contributing
- Support
- Credits
- License
- Acknowledgments
- About Authors
![Product Name Screen Shot][product-screenshot]
(An in-depth paragraph about your project and overview of use.)
Use this repository as a base template to start a new repository with a guided README. The linked files such as LICENSE, CONTRIBUTING guide and CODE OF CONDUCT are optional, though highly recommended.
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:
readme-template
- VS Code
-
- ❤️
(General instructions to get started)
Simply clone or fork this repo and follow instructions in parantheses ( & ) to make edits to suit your needs.
Or use the repo as a template using Github, follow instructions here: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template
(Describe any prerequisites, libraries, OS version, etc., needed before installing program. Ex OS with min version, runtime env with min and max version.)
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 -g- (How/where to download your code)
- (Any modifications needed to be made to files/folders)
- Clone the repo
git clone https://github.com/akshaybhalotia/readme-template.git- Install NPM packages
npm install- (How to run the code)
- (Step-by-step bullets)
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.
code blocks for commands
- (Step-by-step bullets)
code blocks for commands
- (Step-by-step bullets)
code blocks for commands
- (Step-by-step bullets)
code blocks for commands
- (Step-by-step bullets)
code blocks for commands
For more commands and examples, please refer to the Documentation.
(Any advise for common problems or issues.)
command to run if program contains helper info
(FAQs)
(Details about the versioning system followed)
We use SemVer for versioning. For the versions available, see the tags on this repository.
(History of changes made in each version, since this is expected to get long over time it is recommended to keep in a separate file)
See CHANGELOG.
See the open issues for a list of proposed features (and known issues).
(Add a guide for anyone to be able to contribute to the project, either on the readme or as a separate file)
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. Sincere thanks to all our contributors. Thank you, contributors!
You are requested to follow the contribution guidelines specified in CONTRIBUTING.md and code of conduct at CODE_OF_CONDUCT.md while contributing to the project 😄.
(Ask for support or sponsorships by providing links or just add a simple message)
Contributions, issues, and feature requests are welcome! Give a ⭐️ if you like this project!
(Write credits for ideas, special contributions, etc.)
(Legal license info)
This project is licensed under the MIT License - see the LICENSE file for details.
(Inspiration, code snippets, etc.)
This template is inspired by:
(Primary names and contact info)
readme-template is created & maintained by Akshay Bhalotia. You can find me on Twitter - @akshay_bhalotia or write to me at github [at] axy.one.
(You can insert top collaborators here. Also you can include org level stuff here such as:
The names and logos for Acme are trademarks of Acme, Inc.
We love open source software! See our other projects or hire us to help build your product.)