From 97ffcca84fb22153fde9ab1cef87ed9f0498e8f0 Mon Sep 17 00:00:00 2001 From: Kevin Qi Date: Sat, 10 Feb 2018 23:30:59 -0800 Subject: [PATCH] update readme --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 713d8a8..822ef51 100644 --- a/README.md +++ b/README.md @@ -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: ``` -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. |