archive-gh-me/react-circular-progressbar
1
0
Fork 0
mirror of https://github.com/kevinsqi/react-circular-progressbar.git synced 2026-01-18 15:55:06 +00:00
Code Issues Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Kevin Qi 2018-02-10 23:30:59 -08:00
parent 1b40a5af87
commit 97ffcca84f
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -9,10 +9,14 @@ A circular progress indicator component, built with SVG. Easily customizable wit
## Installation
Install the npm module:
Install with yarn or npm:
```bash
npm install react-circular-progressbar
yarn add react-circular-progressbar
```
```bash
npm install --save react-circular-progressbar
```
## Usage
@ -37,10 +41,12 @@ Now you can use the component:
<CircularProgressbar percentage={60} />
```
For more in-depth examples, take a look at the [demo code](docs/demo.jsx) to see JSX for the [live demo page](http://www.kevinqi.com/react-circular-progressbar/).
You can play around with a working example on CodeSandbox: https://codesandbox.io/s/vymm4oln6y
## Props
For examples of how to use props, take a look at the [demo code](docs/demo.jsx) to see JSX for the [live demo page](http://www.kevinqi.com/react-circular-progressbar/).
| Name | Description |
| ---- | ----------- |
| `percentage` | Numeric percentage to display, from 0-100. Required. |