diff --git a/README.md b/README.md index 28d6bec..966c82b 100644 --- a/README.md +++ b/README.md @@ -36,8 +36,9 @@ import CircularProgressbar from 'react-circular-progressbar'; | Name | Description | | ---- | ----------- | | `percentage` | Numeric percentage to display, from 0-100. Required. | -| `strokeWidth` | Width of circular line. Default: `8`. | | `className` | Classes to apply to the svg element | +| `strokeWidth` | Width of circular line as a percentage relative to total width of component. Default: `8`. | +| `backgroundPadding` | Padding between background and edge of svg as a percentage relative to total width of component. Default: `0`. | | `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}%` ``. | diff --git a/docs/demo.jsx b/docs/demo.jsx index 1dfe78b..b01e418 100644 --- a/docs/demo.jsx +++ b/docs/demo.jsx @@ -6,20 +6,6 @@ console.log(`react-circular-progressbar v${COMPONENT_VERSION}`); const githubURL = 'https://github.com/iqnivek/react-circular-progressbar'; -const Config = ({ name, example, description, children }) => ( -
{name}{example ? `e.g. ${example}` : null}
{description}
-