<github-corner>
</> A Polymer 2.0 element for github corner.
How to install and use
1 - Install the element using Bower:
bower install github-corner --save
2 - Import the element:
<link rel="import" href="bower_components/github-corner/github-corner.html">
3 - Start using it!
<github-corner href="https://github.com/afonsopacifer/github-corner"></github-corner>
Properties
Property | Type | Default | Description |
---|---|---|---|
href |
String | # |
Hyperlink reference |
Styling
The following custom properties and mixins are available for styling:
Custom property | Default | Description |
---|---|---|
--github-corner-background | #24292E | Background color |
--github-corner-color | #ffffff | Octocats color |
--github-corner-size | 80px | Badge size |
--github-corner-z-index | 1 | z-index |
Browser Support
Using the webcomponents.js:
Latest |
Latest |
Latest |
Latest |
|
Latest |
Development
1 - Install Bower & Polymer-CLI:
npm install -g bower polymer-cli
2 - Install local dependencies:
bower install
3 - Start the development server:
polymer serve --open
Tests
Linting
Linting with polylint:
polymer lint
Linting with eslint:
npm install -g eslint
npm install -g eslint-plugin-html
eslint *.html
Unit tests
Run tests:
polymer test --skip-plugin sauce
Quick tip: To run the selenium driver for safari, you need follow some instructions.
Versioning
To keep better organization of releases we follow the Semantic Versioning 2.0.0 guidelines.
Contributing
Find on our issues the next steps of the project ;)
Want to contribute? Follow these recommendations.
History
See Releases for detailed changelog.