Skip to content

Commit 6b6bc8a

Browse files
committed
doc: update CDN initialization guide
1 parent 792657e commit 6b6bc8a

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,10 @@ Install the library via npm:
3434
```
3535
npm i vue-ellipse-progress
3636
```
37-
You can initialize the component globally as a plugin or import it a specific component of your app.
37+
You can initialize the component globally as a plugin or import it in a specific component of your app.
3838

3939
#### Initialize as Plugin
40-
Import and initialize the component in your `main.js`. After initialization, the component is available under `<ve-progress/>`.
40+
Import and initialize the component in your `main.js`. After initialization, the component is available as `<ve-progress/>`.
4141
You can also assign a custom name to the component:
4242
```js
4343
import { createApp } from "vue";
@@ -47,21 +47,23 @@ createApp(App).use(veProgress);
4747
```
4848

4949
#### Import component
50+
You also have the option to import the component directly:
5051
```js
5152
import { VeProgress } from 'vue-ellipse-progress';
5253
```
5354

5455
### CDN
55-
Use this option where you have a global Vue.js instance available. You can customize and get the bundled and minified
56+
You can customize and get the bundled and minified
5657
component from [JSDelivr](https://www.jsdelivr.com/package/npm/vue-ellipse-progress).
57-
Just add the following line to your HTML and start using the component, nothing more is required:
58-
58+
Just add the following line to your HTML and initialize the component as plugin:
5959
```html
6060
<script src="https://cdn.jsdelivr.net/npm/vue-ellipse-progress/dist/vue-ellipse-progress.umd.min.js"></script>
61+
...
62+
createApp(App).use(veprogress);
6163
```
6264

6365
## Usage
64-
After you have initialized the component, use it everywhere you want in your application:
66+
After you have initialized the component, you are ready to create your circles:
6567
```html
6668
<ve-progress
6769
:data="circles"

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
"version": "2.0.0-alpha.5",
44
"private": false,
55
"description": "A Vue.js component to create beautiful animated circular progress bars",
6-
"main": "./dist/ve-progress.umd.min.js",
6+
"main": "./dist/veprogress.umd.min.js",
77
"scripts": {
88
"serve": "vue-cli-service serve",
9-
"build": "vue-cli-service build --target lib --formats umd-min --name ve-progress ./src/plugin.js",
9+
"build": "vue-cli-service build --target lib --formats umd-min --name veprogress ./src/plugin.js",
1010
"lint": "vue-cli-service lint --fix",
1111
"test": "vue-cli-service test:unit --colors",
1212
"publish-beta": "npm run lint && npm run build && npm publish --tag beta"

src/components/Gradient.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<template>
22
<component
33
:is="gradientComponent"
4-
:id="`ep-${type}-gradient-${id}`"
4+
:id="\`ep-${type}-gradient-${id}`"
55
x1="0%"
66
y1="100%"
77
x2="0%"

0 commit comments

Comments
 (0)