diff --git a/README.html b/README.html deleted file mode 100644 index a99cc82..0000000 --- a/README.html +++ /dev/null @@ -1,952 +0,0 @@ - - -
- -npm install react-github-stats-card-v2
-
-import { Card } from 'react-github-stats-card-v2';
-
-username
is a required prop. Example: username="cnocon"
theme
is an optional prop that defaults to false if not explicitly passed. Example theme={true}
accessToken
is an optional prop that will raise your rate limit if you start encountering rate limiting errors in your application. Example accessToken="abcdefghijklmnopqrstuv12345678910"
<Card
- username=A-GITHUB-USERNAME
- theme={true}
- accessToken=MY-GITHUB-PERSONAL-ACCESS-TOKEN
-/>
-
-git clone git@github.com:cnocon/react-github-stats-card-v2.git
-cd react-github-stats-card-v2
-
-npm install
from the project root.npm install
-
-npm start
npm start
-
-
-
-
\ No newline at end of file