My go-to README.md template

README.md

{project-name}

{description-short}

{description-long}

Table of Content

• Getting Started
  • Prerequisites
  • Installation
• Development

Getting Started

To get you up and running right away refer to the installation instructions and the needed prerequisites shown below.

Prerequisites

• Terminal
• Node.js

Installation

To install all the dependancies run:

npm install

If you are using yarn:

yarn

Development

Explain how to run the automated tests for this system

Tests

Explain what these tests test and why

Give an example

Styleguide

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Dependancies

• ROME - Used to generate RSS Feeds

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Tomas Sivicki - Initial work - TomSiwik

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Create With Love By

{organisation-name}