Skip to content

Commit

Permalink
patch: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vaban-ru committed Dec 12, 2022
1 parent 2db5f9b commit f2185b3
Showing 1 changed file with 28 additions and 4 deletions.
32 changes: 28 additions & 4 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,13 @@ npm i @webzlodimir/vue-avatar

### Vue 3

Just import component where you want
Just import component and styles in `script` section

```js
import VueAvatar from "@webzlodimir/vue-avatar";
import "@webzlodimir/vue-avatar/dist/style.css";
```vue
<script setup>
import VueAvatar from "@webzlodimir/vue-avatar";
import "@webzlodimir/vue-avatar/dist/style.css";
</script>
```

And use it in `template` tag
Expand All @@ -42,3 +44,25 @@ And use it in `template` tag
<vue-avatar username="Simple User" />
</template>
```

## Develop

To start develop server with demo use command

```
yarn demo
```
or
```
npm run demo
```

To start develop docs, use command

```
yarn docs:dev
```
or
```
npm run docs:dev
```

0 comments on commit f2185b3

Please sign in to comment.