Skip to content
This repository was archived by the owner on Jan 9, 2022. It is now read-only.

Commit a2737bc

Browse files
committed
chore: update README
1 parent 2197c7f commit a2737bc

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

+47
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,50 @@ Customizable, beautifully animated, lightweight. Typescript support
55
🤯 [Documentation](https://gitart-vue-dialog.netlify.app/)
66

77
🤯 [Examples](https://michaelgitart.github.io/gitart-vue-dialog/)
8+
9+
---
10+
11+
- lightweight <br/>
12+
~ 1.7 KiB - style.css <br/>
13+
~ 8.4 KiB - index.js
14+
15+
16+
## Instalation
17+
18+
### Standalone Component
19+
20+
```js
21+
// main.js or YourComponent.vue
22+
import 'gitart-vue-dialog/dist/style.css'
23+
```
24+
25+
```js
26+
// YourComponent.vue
27+
import { GDialog } from 'gitart-vue-dialog'
28+
29+
export default {
30+
components: {
31+
GDialog,
32+
},
33+
}
34+
```
35+
36+
### Plugin
37+
38+
Be sure to read the [вocumentation](https://gitart-vue-dialog.netlify.app/) for using the plugin
39+
40+
```js
41+
import App from './App.vue'
42+
import { plugin as dialogPlugin } from 'gitart-vue-dialog'
43+
import 'gitart-vue-dialog/dist/style.css'
44+
45+
createApp(App)
46+
.use(dialogPlugin)
47+
.mount('#app')
48+
```
49+
50+
51+
52+
## Usage
53+
54+
Read [Documentation](https://gitart-vue-dialog.netlify.app/)

0 commit comments

Comments
 (0)