Skip to content

Commit 0ac0f53

Browse files
Update the readme with more detailed installation instructions
Signed-off-by: Alexandre Bonneau <[email protected]>
1 parent bdc81fe commit 0ac0f53

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Get in touch on [![Gitter chat][gitter-image]][gitter-url]
1212

1313
---
1414

15-
vue-autoNumeric wrap the awesome autoNumeric library and generate an `<input>` element managed by AutoNumeric.
15+
vue-autoNumeric wraps the awesome autoNumeric library and generate an `<input>` element managed by [AutoNumeric](https://github.com/autoNumeric/autoNumeric/).
1616

1717
### Installation
1818

@@ -22,11 +22,26 @@ yarn add vue-autonumeric
2222
npm install vue-autonumeric --save
2323
```
2424

25-
You also need to link the [AutoNumeric](https://github.com/autoNumeric/autoNumeric/) library in your html `<head>` tag like so:
25+
You also need to link the [AutoNumeric](https://github.com/autoNumeric/autoNumeric/) library in your html `<head>` tag since `vue-autonumeric` does not bundle it.
26+
You can link AutoNumeric either with a CDN like so:
2627
```html
2728
<script src="//unpkg.com/autonumeric"></script>
2829
```
2930

31+
...or by importing it too in your source code:
32+
33+
```sh
34+
yarn add autonumeric
35+
# or
36+
npm install autonumeric --save
37+
```
38+
39+
You'll then be able to use the vue-autonumeric component:
40+
```js
41+
import AutoNumeric from 'AutoNumeric';
42+
import VueAutoNumeric from 'vue-autonumeric';
43+
```
44+
3045
### How to use?
3146

3247
The AutoNumeric component can be instantiated the same way `AutoNumeric` can.

0 commit comments

Comments
 (0)