react-github-mark v1.1.1

react-github-mark

About

react-github-mark is an npm package that simply displays octocat in a screen corner which contains a link to your repo (example). Package is bootstrapped using nwb.

Installing

npm i react-github-mark

Usage

Basic

import GithubMark from 'react-github-mark';
...
<GithubMark href="https://www.example.com" />

Props

<GithubMark
  ...
  href="https://www.example.com" // mandatory
  position="top-left"
  position="top-right"
  position="bottom-left"
  position="bottom-right" // default
  padding="8px-8px" // default
  light
  light={false} // default
  ...
/>

Notes

According to this thread in order to use this package you have to use webpack and appropriate file-loader configuration in place (which is almost always is true anyway).

License

react-github-mark is distributed under the MIT-LICENSE.