Skip to content

Commit 0ad81d0

Browse files
committed
chore: update npm readme
1 parent 02a4e89 commit 0ad81d0

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,34 @@ with a bit of imagination you can create really exciting things.
1818

1919
:grey_exclamation: Take a look at some interesting examples on the [Demo page](https://vue-ellipse-progress-demo.netlify.com) :grey_exclamation:
2020

21-
## Usage
21+
## Installation
22+
Use your package manager or CDN to install and initialize the component.
23+
24+
### NPM
2225
Install the library via npm:
2326
```
2427
npm i vue-ellipse-progress
2528
```
26-
The component is provided as a Vue.js plugin. So just initialize it in your `main.js`:
29+
The component is provided as a Vue.js plugin. So just initialize it in your ``main.js``:
2730
```js
2831
import VueEllipseProgress from 'vue-ellipse-progress';
2932

3033
Vue.use(VueEllipseProgress);
3134

3235
// Vue.use(VueEllipseProgress, "vep"); you can define a name and use the plugin like <vep/>
3336
```
34-
Now use the component:
37+
38+
### CDN
39+
Use this option where you have a global Vue.js instance available. You can customize and get the bundled and minified
40+
component from [JSDelivr](https://www.jsdelivr.com/package/npm/vue-ellipse-progress).
41+
Just add the following line to your HTML and start using the component, nothing more is required:
42+
43+
```html
44+
<script src="https://cdn.jsdelivr.net/npm/vue-ellipse-progress/dist/vue-ellipse-progress.umd.min.js"></script>
45+
```
46+
47+
## Usage
48+
After you have initialized the component, use it everywhere you want in your application:
3549
```html
3650
<vue-ellipse-progress
3751
:data="circles"
@@ -56,13 +70,15 @@ Now use the component:
5670
:half="false"
5771
:gap="10"
5872
dot="10 blue"
73+
reverse
5974
fontSize="5rem">
6075

6176
<span slot="legend-value">/200</span>
6277
<p slot="legend-caption">GOOD JOB</p>
6378

6479
</vue-ellipse-progress>
6580
```
81+
6682
## Options
6783
You are ready to go with just following line:
6884
```html

0 commit comments

Comments
 (0)