Web Component wrapper for @mdo's GitHub button using Polymer.
Install the component using Bower:
$ bower install github-button --save
Or download as ZIP.
-
Import Web Components' polyfill:
<script src="bower_components/platform/platform.js"></script>
-
Import Custom Element:
<link rel="import" href="bower_components/github-button/dist/github-button.html">
-
Start using it!
<github-button></github-button>
Attribute | Options | Default | Description |
---|---|---|---|
user |
string | customelements |
GitHub username that owns the repo |
repo |
string | github-button |
GitHub repository to pull the watchers/forks counts |
type |
follow , fork , watch |
watch |
Type of button to show |
count |
true , false |
true |
Show the number of watchers/forks |
height |
int | 25 |
The height of the button |
width |
int | 100 |
The width of the button |
size |
large , regular |
regular |
Indicates the button size |
See GitHub Buttons' official documentation.
In order to run it locally you'll need to fetch some dependencies and a basic server setup.
-
$ [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
- 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
For detailed changelog, check Releases.
MIT License © Zeno Rocha