Skip to content

Commit

Permalink
Merge pull request #4 from bcastlel/fix/yarn-mention
Browse files Browse the repository at this point in the history
mention yarn in README.md
  • Loading branch information
bcastlel authored Feb 22, 2023
2 parents 8dfce73 + 3b4a7c8 commit 6a31372
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,16 @@
**A scroll lock tool for Vue 3.** Works fine on all devices (and browsers). Uses [body-scroll-lock](https://github.com/willmcpo/body-scroll-lock) under the hood. Designed by analogy with [v-scroll-lock](https://github.com/phegman/v-scroll-lock), but intended for Vue 3. I've decided to make it separate from [v-scroll-lock](https://github.com/phegman/v-scroll-lock) because I'm going to improve this tool in the near future.

## Installation & Setup
#### NPM
```bash
npm install v3-scroll-lock
```

#### Yarn
```bash
yarn add v3-scroll-lock
```

After installation, you have to use the plugin you've just installed in `main.js` (or `main.ts`).

```javascript
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "v3-scroll-lock",
"version": "1.2.0",
"version": "1.2.1",
"description": "A scroll lock tool for Vue 3",
"type": "module",
"main": "dist/v3-scroll-lock.umd.cjs",
Expand Down

0 comments on commit 6a31372

Please sign in to comment.