diff --git a/README.html b/README.html deleted file mode 100644 index a99cc82..0000000 --- a/README.html +++ /dev/null @@ -1,952 +0,0 @@ - - - - - React GitHub Stats Card (v2) - - - - - - - - - -

React GitHub Stats Card (v2)

-

Screenshot of component

-

Installation

-
    -
  1. Install the package via npm.
  2. -
-
npm install react-github-stats-card-v2 -
-
    -
  1. Import the component to file you want to use it in.
  2. -
-
import { Card } from 'react-github-stats-card-v2'; -
-
    -
  1. Place the component on the page.
  2. -
- -
<Card - username=A-GITHUB-USERNAME - theme={true} - accessToken=MY-GITHUB-PERSONAL-ACCESS-TOKEN -/> -
-

Using Storybook

-
    -
  1. Clone this repository and cd into the root directory:
  2. -
-
git clone git@github.com:cnocon/react-github-stats-card-v2.git -cd react-github-stats-card-v2 -
-
    -
  1. Run npm install from the project root.
  2. -
-
npm install -
-
    -
  1. Run npm start
  2. -
-
npm start -
- - - \ No newline at end of file