From 824cf496a580ea16fb0fcffac1c8fef9ec1e6acc Mon Sep 17 00:00:00 2001 From: Kevin Qi Date: Sat, 4 Feb 2017 20:51:42 -0800 Subject: [PATCH] Add props to README, fixes #4 --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7a97ec4..75e99b3 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,17 @@ import CircularProgressbar from 'react-circular-progressbar'; ``` -See the [live demo page](http://www.kevinqi.com/react-circular-progressbar/) for examples and configuration options. +## Props + +| Name | Description | +| ---- | ----------- | +| `percentage` | Numeric percentage to display, from 0-100. Required. | +| `strokeWidth` | Width of circlar line. Default: `false`. | +| `initialAnimation` | Toggle whether to animate progress starting from 0% on initial mount. Default: `false`. | +| `classForPercentage` | Function which returns an additional class to apply to top-level svg element, which can be used for coloring/styling percentage ranges differently. Example: `(percent) => percent < 100 ? 'incomplete' : 'complete'`. | +| textForPercentage | Function which returns text to display, can be configured based on percentage. Example: ``(pct) => `${pct}%` ``. | + +See the [demo page JSX](docs/demo.jsx) to see code used on the live demo page. ## Development