README.md

<x-carousel>

My awesome Custom Element

Demo

Check it live!

Install

Install the component using Bower:

$ bower install x-carousel --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/x-carousel/dist/x-carousel.html">

3. Start using it!

   <x-carousel></x-carousel>

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.

• Install Bower & Gulp:

  $ [sudo] npm install -g bower gulp

• Install local dependencies:

  $ bower install && npm install

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

  $ gulp server

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

  $ gulp build

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

  $ gulp 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