Skip to content

Commit

Permalink
Merge pull request #3 from LottieFiles/docs/readme-update
Browse files Browse the repository at this point in the history
docs(readme and deps): updated lottie-player dep version and readme
  • Loading branch information
samuelOsborne authored Dec 13, 2021
2 parents 33d1fd5 + d366bfd commit 98c0865
Show file tree
Hide file tree
Showing 3 changed files with 3,052 additions and 98 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
This is a Vue component for the Lottie Web Player. This library is a vue wrapper around the LottieFiles Lottie Web Player

![screencast](https://github.com/LottieFiles/lottie-vue/blob/master/demo.gif)

#### In Javascript or TypeScript:

1. Install package using npm or yarn.
Expand All @@ -22,6 +23,42 @@ import LottieVuePlayer from "@lottiefiles/vue-lottie-player";
Vue.use(LottieVuePlayer);
```

#### With Nuxt:

1. Install package using npm or yarn.

```shell
npm install --save @lottiefiles/vue-lottie-player
```

2. Create a folder called 'plugins' at the root of your project

3. Create a file named 'lottie-vue-player.client.js' inside the 'plugins' directory

4. Inside this file put :

```javascript

import Vue from 'vue';

import LottieVuePlayer from "@lottiefiles/vue-lottie-player";

Vue.use(LottieVuePlayer);

```

5. Add to nuxt.config.js:

```javascript

plugins: [
"~/plugins/lottie-vue-player.client.js"
]

```

---

## Example/Development

1. Clone repo
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
],
"license": "MIT",
"dependencies": {
"@lottiefiles/lottie-player": "^1.0.4",
"@lottiefiles/lottie-player": "^1.5.2",
"vue": "^2.6.12",
"vue-clickaway": "^2.2.2"
},
Expand Down
Loading

0 comments on commit 98c0865

Please sign in to comment.