Skip to content
This repository has been archived by the owner on Apr 18, 2022. It is now read-only.

Latest commit

 

History

History
96 lines (62 loc) · 2.16 KB

README.md

File metadata and controls

96 lines (62 loc) · 2.16 KB

<ganbaru-zoi>

A bare minimum custom element starter-kit using Polymer.

Like Yeoman? Use the generator-element instead.

Looking for a working example? Check hello-world-polymer.

Demo

Check it live!

Install

Install the component using Bower:

$ bower install ganbaru-zoi --save

Usage

  1. Import Web Components' polyfill:

    <script src="bower_components/platform/platform.js"></script>
  2. Import Custom Element:

    <link rel="import" href="bower_components/ganbaru-zoi/dist/ganbaru-zoi.html">
  3. Start using it!

    <ganbaru-zoi></ganbaru-zoi>

Options

Attribute Options Default Description
message string 今日も一日がんばるぞい! 青葉に言わせたいこと.

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, 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