A template for Github READMEs (Markdown)

README.md

[project]

[emoji] Simple description of what it does (1 line).

[logo]

[project] is a [definition].

NOTE: Explanation on the needs for that project.

This project was created for this issue.

Installation

Prerequisites

To build this project, you first need to install the following dependencies:

• foobar, foobar-dev
• foobarfoo or foobarfooz1 (depending on your distribution)
• (optional) foobaz-cli

Building

Simply type in the [project] directory:

npm run build

NOTE: Building options should be included here.

Installing

npm install [project]

or

sudo npm install [project] -g

to install it globally.

Getting Started

NOTE: Information on how to use the project demo or sample. This should not try to explain the internals, but to show what the project does.

Contributing

To contribute to this project, please read the Contribute.md file.

History

NOTE: It's the release history. We should not bother explaining experimental stuff or what is not in a stable state.

• 0.2.1
  • CHANGE: Update docs (module code remains unchanged)
• 0.2.0
  • CHANGE: Remove setDefaultXYZ()
  • ADD: Add init()
• 0.1.1
  • FIX: Crash when calling baz() (Thanks @GenerousContributorName!)
• 0.1.0
  • The first proper release
  • CHANGE: Rename foo() to bar()
• 0.0.1
  • Work in progress

To read more about the current development, please read the ChangeLog.md file.

Credits

NOTE: This section should include library used and people that gave technical answers (i.e. StackOverflow).

Special thanks to the contributors of this project.

License

Unless otherwise noted, this directory and the whole project is subject to the [license] license.

Copyright (c) 2017 [copyrightHolder]