Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 1.7 KB

README-library-example.md

File metadata and controls

80 lines (53 loc) · 1.7 KB

{{libraryname}}

npm dependencies Status

...

Table of Contents

Install

You can get it on npm

$ npm install --save {{libraryname}}

Then import it with a module bundler like rollup or webpack

// using ES6 modules
import {{libraryname}} from '{{libraryname}}'

// using CommonJS modules
var {{libraryname}} = require('{{libraryname}}')

There is also an UMD build available on unpkg:

<script src="https://unpkg.com/{{libraryname}}"></script>

You can find the library on window.{{libraryname}}.

Usage

...

Examples & Demos

Soon :)

API

...

Contribute

All contributions are welcome.

  • Fork the repo on GitHub
  • Clone the project to your own machine
  • Install the tools necessary for development: npm install
  • Make your changes and test it: npm test
  • Commit it to your own branch
  • Push your work back up to your fork
  • Submit a pull request with full remarks documenting your changes

Browser Support

...