There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template 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 implement DRY principles to the rest of your life 😄
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
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.
- ´Clone the repo´
git clone https://github.com/FrancoPeron/owslagoods.git
- Install NPM packages
npm install
- Server App
npm run dev
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.
Distributed under the MIT License. See LICENSE.txt for more information.
fdsfrrtdhdfghdrthdfgjdfghdrthfghdfh
Your Name - @your_twitter - email@example.com
Project Link: https://github.com/your_username/repo_name