chore: 🤖 update README (#102)

LottieFiles · Jan 13, 2024 · c966d77 · c966d77
1 parent 7f91105
commit c966d77
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -51,6 +51,7 @@ The monorepo contains the following package:
 | **[@lottiefiles/dotlottie-web](packages/web/README.md)**     | A JavaScript library for rendering Lottie and dotLottie animations in the browser or Node.js.                                                                          |
 | **[@lottiefiles/dotlottie-react](packages/react/README.md)** | A React component wrapper for `dotlottie-web` that provides a declarative API for rendering Lottie and dotLottie animations and UI controls for interacting with them. |
 | **[@lottiefiles/dotlottie-wc](packages/wc/README.md)**       | A Web Component wrapper for `dotlottie-web` that provides a declarative API for rendering Lottie and dotLottie animations and UI controls for interacting with them.   |
+| **[@lottiefiles/dotlottie-vue](packages/vue/README.md)**     | A Vue component wrapper for `dotlottie-web` that provides a declarative API for rendering Lottie and dotLottie animations and UI controls for interacting with them.   |
 
 > Note: Each package has its own README.md with detailed documentation on usage and APIs.
 
@@ -60,7 +61,6 @@ We are actively working on expanding our suite of packages. Here's what's coming
 
 | Package                         | Description                                                                                                                                                             |
 | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `@lottiefiles/dotlottie-vue`    | A Vue component wrapper for `dotlottie-web` that provides a declarative API for rendering Lottie and dotLottie animations and UI controls for interacting with them.    |
 | `@lottiefiles/dotlottie-svelte` | A Svelte component wrapper for `dotlottie-web` that provides a declarative API for rendering Lottie and dotLottie animations and UI controls for interacting with them. |
 
 Stay tuned for updates and releases of these new packages!

diff --git a/packages/vue/README.md b/packages/vue/README.md
@@ -19,7 +19,7 @@
 * [Usage](#usage)
 * [APIs](#apis)
   * [DotLottieVue Props](#dotlottievue-props)
-  * [Listening to DotLottie Events](#listening-to-dotlottie-events)
+  * [Listening to Events](#listening-to-events)
 * [Development](#development)
   * [Setup](#setup)
   * [Dev](#dev)
@@ -70,9 +70,17 @@ import { DotLottieVue } from '@lottiefiles/dotlottie-vue'
 | `renderConfig`          | RenderConfig          |          | `{}`                  | Configuration for rendering the animation.                                                                                                                                                                                                         |
 | `useFrameInterpolation` | boolean               |          | false                 | Determines if the animation should update on subframes. If set to false, the original AE frame rate will be maintained. If set to true, it will refresh at each requestAnimationFrame, including intermediate values. The default setting is true. |
 
-### Listening to [DotLottie](../web/README.md) Events
+#### RenderConfig
 
-```vue
+The `renderConfig` object accepts the following properties:
+
+| Property name      | Type   | Required | Default                       | Description             |
+| ------------------ | ------ | :------: | ----------------------------- | ----------------------- |
+| `devicePixelRatio` | number |          | window\.devicePixelRatio \| 1 | The device pixel ratio. |
+
+### Listening to Events
+
+```javascript
 <script setup>
 import { onMounted, ref, watch } from 'vue';
 import { DotLottieVue } from '@lottiefiles/dotlottie-vue'
@@ -96,15 +104,7 @@ onMounted(() => {
 </template>
 ```
 
-> Refer to [DotLottie](../web/README.md) Events sections to know more about all available events.
-
-#### RenderConfig
-
-The `renderConfig` object accepts the following properties:
-
-| Property name      | Type   | Required | Default                       | Description             |
-| ------------------ | ------ | :------: | ----------------------------- | ----------------------- |
-| `devicePixelRatio` | number |          | window\.devicePixelRatio \| 1 | The device pixel ratio. |
+> Refer to [dotlottie-web](../web/README.md) Events sections to know more about all available events.
 
 ## Development