Skip to content

Custom Web Component to display your github profile as a widget on your website or web app

License

Notifications You must be signed in to change notification settings

GeoDoo/github-profile-widget

Repository files navigation

CircleCI Published on webcomponents.org semantic-release Commitizen friendly

<github-profile-widget>

A web component to show a profile widget for your Github account that can be easily embedded to your website.

How to use

<github-profile-widget username="GeoDoo"></github-profile-widget>
<script src="https://npmcdn.com/github-profile-widget@<version-you-want>/github-profile-widget.js"></script>

or you can use npm or yarn:

$ npm install --save github-profile-widget
$ yarn install --save github-profile-widget

Live demo

You can check the widget on the footer of my blog: https://geodoo.work

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

License

This work is licensed under the GNU LESSER GENERAL PUBLIC LICENSE.

About

Custom Web Component to display your github profile as a widget on your website or web app

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published