Skip to content

Instantly share code, notes, and snippets.

@jstgermain
Created August 6, 2019 19:38
Show Gist options
  • Save jstgermain/09fe46be10a05a01dd4943dcdd5e991a to your computer and use it in GitHub Desktop.
Save jstgermain/09fe46be10a05a01dd4943dcdd5e991a to your computer and use it in GitHub Desktop.
README.template.md

Product Name

Short blurb about what your product does.

NPM Version Build Status Downloads Stats

One to two paragraph statement about your product and 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

  • 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

Meta

Your Name – @YourTwitterYourEmail@example.com

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment