https://github.com/sabarasaba/github-ribbon

A web component for displaying a Github ribbon using Polymer.
https://github.com/sabarasaba/github-ribbon

Last synced: 16 days ago
JSON representation

A web component for displaying a Github ribbon using Polymer.

• Host: GitHub
• URL: https://github.com/sabarasaba/github-ribbon
• Owner: sabarasaba
• Created: 2014-05-18T09:55:37.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-05-18T10:09:24.000Z (over 10 years ago)
• Last Synced: 2024-11-10T03:18:45.998Z (about 2 months ago)
• Homepage: http://ignaciorivas.me/github-ribbon/
• Size: 379 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# <github-ribbon>

Web Component Displays a Github ribbon [Github Ribbon] using Polymer.

## Demo

> [Check it live](http://ignaciorivas.me/github-ribbon/).

## Install

Install the component using [Bower](http://bower.io/):

```sh

$ bower install github-ribbon --save

```

Or [download as ZIP](https://github.com/sabarasaba/github-ribbon/archive/master.zip).

## Usage

1. Import Web Components' polyfill:

  ```html

  ```

2. Import Custom Element:

  ```html

  ```

3. Start using it!

  ```html

  ```

## Options

Attribute  | Options         | Default                    | Description

---        | ---             | ---                        | ---

`user`     | *username*      | `sabarasaba`               | The username of the repo

`repo`     | *repository*    | `github-ribbon`            | The name of the repo

`color`    | `red`, `green`, `black`, `orange`, `gray`, `black` | `red`                  | The background color of the ribbon

`position` | `right`, `left` | `right`                    | The position of the ribbon

## Browser Support

![IE](https://raw.github.com/paulirish/browser-logos/master/internet-explorer/internet-explorer_48x48.png) | ![Chrome](https://raw.github.com/paulirish/browser-logos/master/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/paulirish/browser-logos/master/firefox/firefox_48x48.png) | ![Opera](https://raw.github.com/paulirish/browser-logos/master/opera/opera_48x48.png) | ![Safari](https://raw.github.com/paulirish/browser-logos/master/safari/safari_48x48.png)

--- | --- | --- | --- | --- |

IE 10+ ✔ | Latest ✔ | Latest ✔ | Latest ✔ | Latest ✔ |

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

Check [Release](https://github.com/sabarasaba/github-ribbon/releases) list.

## License

[MIT License](http://mvaldetaro.mit-license.org/) © Ignacio Rivas