My README.md template.

README.md

{{Name}}

{{Description}}

Installation

$ component install pazguille/{{name}}

See: https://github.com/component/component

Standalone

Also, you can use the standalone version:

<script src="{{source-to-standalone}}.js"></script>

How-to

First step:

// {{Some code here!}}

API

{{class}}#{{method}}(parameters)

Descriptions

• {{parameter}} - Description

{{class}}.{{method}}(parameters);

Contact

• Guillermo Paz (Frontend developer - JavaScript developer | Web standards lover)
• E-mail: [email protected]
• Twitter: @pazguille
• Web: http://pazguille.me

License

Copyright (c) {{year}} @pazguille Licensed under the MIT license.