[Project's Logo]
[Project's name]
[Project's description]
[Project's badges]
About • Key Features • Getting Started • FAQ • Roadmap • Support • License
About
Simple overview of use/purpose.
Key Features
- Feature 1
- Feature 2
- Feature 2.1
- Feature 2.2
- Feature 3
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
Installing and Running
Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
# Clone this repository
$ git clone https://github.com/[your-github-user]/[your-repository-name]
# Go into the repository
$ cd [your-repository-name]FAQ
Is it any good?
Roadmap
- Add this README.
- Finish the unicorn project.
Emailware
[Project's name] is an emailware. Meaning, if you liked using this app or it has helped you in any way, I'd like you send me an email at your-email@email.com about anything you'd want to say about this software. I'd really appreciate it!
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!
- 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
Support
You can also support us by:
License
Your license here.
Acknowledgments
Inspiration, code snippets, etc.
You may also like...
List of apps or libs that do similar stuff as your project.
abehidek.me · GitHub @abehidek · Twitter @guilhermehabe