[Project's badges]
About • Key Features • Getting Started • FAQ • Roadmap • Support • License
Simple overview of use/purpose.
- Feature 1
- Feature 2
- Feature 2.1
- Feature 2.2
- Feature 3
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.
This is an example of how to list things you need to use the software and how to install them.
- npm
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]- This are constraints you give to your project
- Here's another constraint: use this README!
- Add this README.
- Finish the unicorn project.
[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!
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
- Clone it open the repository in command line
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a pull request from your feature branch from your repository into this repository main branch, and provide a description of your changes
You can also support us by:
Your license here.
Inspiration, code snippets, etc.
List of apps or libs that do similar stuff as your project.
hidek.xyz · GitHub @abehidek · Twitter @guilhermehabe