Skip to content

Commit

Permalink
chore: release v0.4.0
Browse files Browse the repository at this point in the history
  • Loading branch information
tmg0 committed Sep 20, 2024
1 parent 8f06bcb commit d2b9750
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@

🙌 Easy to use

✅ Support most of the @vueuse/motion's props
✅ Support most of the `@vueuse/motion`'s props

🚀 Support auto-import feature through `nuxt-module`

## Installation

Expand Down Expand Up @@ -93,9 +95,9 @@ const vHero = directive()
</template>
```

### Nuxt
### Nuxt (>= 0.4.0)

`hero-motion` also provide nuxt module for quick start
`hero-motion` also provides a Nuxt module for quick and easy integration

```ts
// nuxt.config.ts
Expand All @@ -104,7 +106,8 @@ export default defineNuxtConfig({
})
```

`hero-motion/nuxt` will auto import `Hero` component, and do not need to wrap root component with `HeroProvider`.
`hero-motion/nuxt` will auto import the `Hero` component for you, eliminating the need to manually import it in each file where you want to use it.
Additionally, this module automatically wraps your Nuxt application with the `HeroProvider`, saving you the step of explicitly wrapping your root component. This streamlined setup process not only reduces boilerplate code but also ensures that the Hero motion functionality is available throughout your entire Nuxt application with minimal configuration effort on your part.

## Playground

Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "hero-motion",
"version": "0.4.0-alpha.3",
"version": "0.4.0",
"packageManager": "[email protected]",
"description": "A shared layout animations for vue like framer motion.",
"author": "zekun.jin",
Expand All @@ -16,6 +16,7 @@
"keywords": [
"animation",
"vue",
"framer",
"motion",
"vueuse"
],
Expand Down

0 comments on commit d2b9750

Please sign in to comment.