bitroniq / readme-template

This is a README.md template to use in projects.

Product Name

Short text about your project and what it does.

Short (up to two paragraphs) statement about your product:

• The purpose.
• What it does.

Installation

OS X & Linux:

npm install my-module --save

Windows:

edit autoexec.bat

Usage example

A few motivating and useful examples of how your product can be used. Spice this up with code blocks and potentially more screenshots.

For more examples and usage, please refer to the Wiki.

Development setup

Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.

make install
npm test

Release History

All notable changes to this project will be documented in this section.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

How do I make a good changelog?

Guiding Principles

• Changelogs are for humans, not machines.
• There should be an entry for every single version.
• The same types of changes should be grouped.
• Versions and sections should be linkable.
• The latest version comes first.
• The release date of each version is displayed.
• Mention whether you follow Semantic Versioning.

Types of changes

• Added for new features.
• Changed for changes in existing functionality.
• Deprecated for soon-to-be removed features.
• Removed for now removed features.
• Fixed for any bug fixes.
• Security in case of vulnerabilities.

Unreleased

v1.1 - 2018-07-17

Fixed

• Fixed some typos

Added

• This CHANGELOG file to hopefully serve as an evolving example of a standardized open source project CHANGELOG.

v1.0 - 2018-07-17

Fixed

• Some typos

---

Meta

Your Name – @YourTwitter – [e-mail]

Distributed under the XYZ license. See LICENSE for more information.

https://github.com/yourname/github-link

Contributing

1. Fork it (https://github.com/yourname/yourproject/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request