0.1.0 • Published 10 years ago
my-repo v0.1.0
<my-repo>
My awesome Custom Element
Demo
Install
Install the component using Bower:
$ bower install my-repo --saveOr download as ZIP.
Usage
Import Web Components' polyfill:
<script src="bower_components/webcomponentsjs/webcomponents.min.js"></script>Import Custom Element:
<link rel="import" href="bower_components/my-repo/dist/my-element.html">Start using it!
<my-element></my-element>
Options
| Attribute | Options | Default | Description |
|---|---|---|---|
foo | string | bar | Lorem ipsum dolor. |
Methods
| Method | Parameters | Returns | Description |
|---|---|---|---|
unicorn() | None. | Nothing. | Magic stuff appears. |
Events
| Event | Description |
|---|---|
onsomething | Triggers when something happens. |
Development
In order to run it locally you'll need to fetch some dependencies and a basic server setup.
$ [sudo] npm install -g bower grunt-cliInstall local dependencies:
$ bower install && npm installTo test your project
$ grunt testTo view your project, start the development server and open
http://localhost:8000.$ grunt serverTo build the distribution files before releasing a new version.
$ grunt buildTo provide a live demo, send everything to
gh-pagesbranch.$ grunt deploy
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -m 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request :D
History
For detailed changelog, check Releases.
License
0.1.0
10 years ago