butter-github-star - Vaadin Add-on Directory
Butter collection / Number of stars of a Github repository.
**[ This description is mirrored from README.md at [github.com/JCrestel/butter-github-star](https://github.com//JCrestel/butter-github-star/blob/v1.0.3/README.md) on 2019-05-10 ]**
# \ [![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/JCrestel/butter-github-star) [![Build Status](https://travis-ci.org/JCrestel/butter-github-star.svg?branch=master)](https://travis-ci.org/JCrestel/butter-github-star)
### This web-component shows the number of stars of a Github repository.
```html
```
## Installation
Install the component using [Bower](https://bower.io/)
```$ bower install butter-github-star --save```
## Usage
* Import Web Components's polyfill (if needed):
```html
```
* Import the component:
```html
```
* Use the component:
```html
```
### Attributes
Attribute | Type | Mandatory | Description
----------|:----:|:---------:|-------------
`user` | *String* | Yes | User on Github
`repository` | *String* | Yes | Repository of the user
### Styling
`` provides the following custom properties for styling:
Custom property | Description | Default
----------------|-------------|----------
`--butter-icon-color` | Color of the star | `--iron-icon-fill-color`
`--iron-icon-fill-color` | Color of the star if `--butter-icon-color` not defined | black
`--butter-background-color` | Background color of left part | #e6ebf1
`--butter-border-color` | Border color | rgba(27,31,35,0.35)
`--butter-font-familly` | Font familly | 'Roboto', 'Noto', sans-serif
## 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
## License
[Apache 2.0](http://www.apache.org/licenses/LICENSE-2.0)
GitHub HomepageIssue tracker
View on GitHub
Online Demo
Documentation
butter-github-star version 1.0.0
### Dependencies
PolymerElements/iron-icons#^2.0.1
* Polymer/polymer#^2.0.1
butter-github-star version 1.0.1
### Dependencies
* iron-icons#PolymerElements/iron-icons#^2.0.1
* polymer#Polymer/polymer#^2.0.1
butter-github-star version 1.0.2
### Dependencies
* iron-icons#PolymerElements/iron-icons#^2.0.1
* polymer#Polymer/polymer#^2.0.1
butter-github-star version 1.0.3
### Dependencies
* iron-icons#PolymerElements/iron-icons#^2.0.1
* polymer#Polymer/polymer#^2.0.1