Skip to content

Instantly share code, notes, and snippets.

@NicolasRitouet

NicolasRitouet/README.md

Last active August 29, 2015 14:10
Show Gist options
  • Save NicolasRitouet/69d441d2e8235a1d5f11 to your computer and use it in GitHub Desktop.
Save NicolasRitouet/69d441d2e8235a1d5f11 to your computer and use it in GitHub Desktop.
Download ZIP
Default readme.md for dpd modules
Raw
README.md

dpd-mymodule

Description

Here, describe what this module is about

Getting started

This module requires deployd ~0.7.0.

If you haven't used Deployd before, make sure to read the documentation.

Installation without package.json

npm install dpd-mymodule

Installation with package.json

If you have a package.json, you'll have to add this module in it.

npm install dpd-mymodule --save

Once it is installed, Deployd will automatically load it.
For more information about Modules, take a look at the module page on the deployd documentation.

The dpd-mymodule module

Overview

Describe the api and how this module works.

Options/Settings

List the options (if any)

Usage example

Write a few usage examples

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality.

Release history

Eventually, a release history

Contributors

List of contributors

@ericfong
Copy link

ericfong commented Dec 3, 2014

"lieu of a formal styleguide" typo ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment