(You can also add project's logo here if you want)
one-line that briefy describes what this project is about
What is this project about? Adds a description about this project, describe what it does. E.g., This is a README template that you can copy-paste your README.md from and use on your projects.
Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible.
- E.g Ruby version
2.6.3 - E.g PostgreSQL
- E.g Node version
x.x.x - Docker
Install project's dependences:
command install
Install gems:
bundle install
Install javascript depedences:
npm install
Database setup:
command to setup
Running the server:
run server
Running tests:
run tests
Running docker:
docker-compose up
Explain how the deploy is done and who needs to be contact for further information.
List ideas for next steps, you can list missing features, improvements ideas...
Tell how people can contribute with this project, you can mention:
- Contributor Guidelines
- Code Style/Requirements
- Format for commit messages
E.g. Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. For minor changes, please fork this repository, make the changes and submit your pull request with comprehensive description of changes.
Tell people where they can go to for help, or to ask further questions or give feedback in general. Add contact e-mail.
For open source projects, say how it is licensed.
- This project is licensed under MIT
- This project is licensed under Creative Commons Attribution License
- This project is licensed under Unlicense license. This license does not require you to take the license with you to your project.