react-github-repo-panel
v1.1.3
Published
A beautiful card that displays Github repository infos.
Downloads
29
Readme
react-github-repo-panel
A beautiful card that displays Github repository infos.
Demo Show
Online Demo Webside
Local
git clone https://github.com/InfiniteSynthesis/react-github-repo-panel.git cd react-github-repo-panel npm i npm start
open
localhost:3001
How to Use 🍕
install
npm i react-github-repo-panel
import
import import { RepoCard } from 'react-github-repo-panel'
use
<RepoCard username="InfiniteSynthesis" reponame="react-github-repo-panel" />
Settings 🔨
| Parameter | Type | Default | Description|
| :----------: |:---:| :---:| :------------- |
| username
| String | "" | User name of this repository. |
| reponame
| String | "" | Name of the repository. |
| center
| Boolean | false | If card is aligned center. |
| squareAvatar
| Boolean | false | If avatar is displayed with square outline. |
| descriptionLine
| Number | 2 | The maximum line of repo description. |
| showLanguage
| Boolean | true | If the repo language is displayed. |
| showLicense
| Boolean | true | If the repo license is displayed. |