github-repository - Vaadin Add-on Directory
GitHub Repository Web Component<github-repository>
====
[![Version Status](https://img.shields.io/npm/v/github-repository.svg?style=flat&label=version&colorB=4bc524)](https://npmjs.com/package/github-repository)
[![macOS Build Status](https://img.shields.io/circleci/project/github/abraham/github-repository.svg?style=flat&label=macos)](https://circleci.com/gh/abraham/github-repository)
[![Linux Build Status](https://img.shields.io/travis/abraham/github-repository.svg?style=flat&label=linux)](https://travis-ci.org/abraham/github-repository)
[![Windows Build Status](https://img.shields.io/appveyor/ci/abraham/github-repository.svg?style=flat&label=windows)](https://ci.appveyor.com/project/abraham/github-repository)
[![Dependency Status](https://david-dm.org/abraham/github-repository.svg?style=flat)](https://david-dm.org/abraham/github-repository)
Install
----
Polyfill tags if you need them. This will include ShadowDOM and Custom Elements support.
```
```
Loading this component. It would be a good idea to use a specific version instead of `latest`.
```
```
Example
----
[Live demo](https://codepen.io/abraham/pen/PQoeqV)
Usage
----
Set the `owner-repo` attribute to the `username/repository` of a GitHub repository.
```
```
![Example](/images/simple.png)
For more advanced usage you can include:
- `` to include a preview image
- A number of `` to include status badges
```
```
![Example with image and badges](/images/advanced.png)
GitHub API Rate limit
----
This Web Component makes unauthenticated requests to the GitHub API. Since the GitHub API has a fairly restrictive 60 requests/hour per IP address, API responses are cached in `localStorage`.
License
----
GithubRepository is released under an MIT license.
Built, tested, and published with [Nutmeg](https://nutmeg.tools).