0.1.0 • Published 8 years ago

my-repo v0.1.0

Weekly downloads
1
License
Apache-2.0
Repository
github
Last release
8 years ago

<my-repo>

My awesome Custom Element

Demo

Check it live!

Install

Install the component using Bower:

$ bower install my-repo --save

Or download as ZIP.

Usage

  1. Import Web Components' polyfill:

    <script src="bower_components/webcomponentsjs/webcomponents.min.js"></script>
  2. Import Custom Element:

    <link rel="import" href="bower_components/my-repo/dist/my-element.html">
  3. Start using it!

    <my-element></my-element>

Options

AttributeOptionsDefaultDescription
foostringbarLorem ipsum dolor.

Methods

MethodParametersReturnsDescription
unicorn()None.Nothing.Magic stuff appears.

Events

EventDescription
onsomethingTriggers when something happens.

Development

In order to run it locally you'll need to fetch some dependencies and a basic server setup.

  • Install Bower & Grunt:

    $ [sudo] npm install -g bower grunt-cli
  • Install local dependencies:

    $ bower install && npm install
  • To test your project

    $ grunt test
  • To view your project, start the development server and open http://localhost:8000.

    $ grunt server
  • To build the distribution files before releasing a new version.

    $ grunt build
  • To provide a live demo, send everything to gh-pages branch.

    $ grunt deploy

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -m 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

History

For detailed changelog, check Releases.

License

MIT License