Skip to content
This repository was archived by the owner on Feb 24, 2023. It is now read-only.

Commit 1e90493

Browse files
author
Łukasz Florczak
committed
README / Installation section update
1 parent 6941405 commit 1e90493

File tree

1 file changed

+28
-2
lines changed

1 file changed

+28
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ More demos and examples coming soon in [vue-agile CodePens collection](https://c
1515

1616
If you like the component remember to **star it** ⭐️. If you appreciate my work you can also **[buy me a coffee](https://ko-fi.com/lukaszflorczak)** ☕️ 😉
1717

18-
---
18+
---
1919

2020
## Important – update from version < `1.0`
2121

@@ -50,13 +50,39 @@ npm install vue-agile
5050

5151
**The component is delivered without styles for the appearance of the navigation elements** (like dots color and shape, arrows position, etc.). I think most people use their own styles and default styles are completely redundant. If you want, feel free to use styles from [CodePen demos](https://codepen.io/collection/AdRzJW/).
5252

53-
## Usage
53+
## Importing
54+
55+
**Global:**
56+
5457
```js
58+
// main.js
5559
import Vue from 'vue'
5660
import VueAgile from 'vue-agile'
5761

5862
Vue.use(VueAgile)
5963
```
64+
65+
**In component:**
66+
```js
67+
// YourComponent.vue
68+
import { VueAgile } from 'vue-agile'
69+
70+
export default {
71+
components: {
72+
agile: VueAgile
73+
}
74+
}
75+
```
76+
77+
**Via `<script>`**:
78+
79+
```html
80+
<script src="https://unpkg.com/vue-agile"></script>
81+
<link rel="stylesheet" href="https://unpkg.com/vue-agile/dist/VueAgile.css">
82+
```
83+
84+
## Usage
85+
6086
```vue
6187
<template>
6288
<agile>

0 commit comments

Comments
 (0)