Skip to content

Commit 46a2698

Browse files
committed
update readme
1 parent c86a081 commit 46a2698

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,16 @@
22
This is a Nuxt wrapper for [Lenis](https://lenis.studiofreight.com/) by [Studio Freight](https://studiofreight.com/). Thank them for the incredible tool.
33

44
## Getting Started
5-
coming soon!
6-
7-
8-
9-
10-
## Development
11-
- Run `npm run dev:prepare` to generate type stubs.
12-
- Use `npm run dev` to start [playground](./playground) in development mode.
5+
1. `yarn add nuxt-lenis`
6+
2. Add `nuxt-lenis` to your modules in nuxt.config
7+
3. In your `app.vue` file, wrap the nuxt page in the lenis component
8+
```
9+
<lenis
10+
:options="LenisOptions"
11+
@initiated="foo"
12+
@scroll="fooBar"
13+
>
14+
<NuxtPage />
15+
</lenis>
16+
```
1317

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "nuxt-lenis",
3-
"version": "1.0.0",
3+
"version": "1.0.1",
44
"license": "MIT",
55
"type": "module",
66
"repository": {

0 commit comments

Comments
 (0)