Skip to content

Commit 04fdc6b

Browse files
committed
imp: basic README (detailed docs to follow)
1 parent 0777fcd commit 04fdc6b

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,20 @@ Find and replace all on all files (CMD+SHIFT+F):
77
- Description: My new Nuxt module
88
-->
99

10-
# My Module
10+
# `useQueryRef` - URL-persisted `ref` for Nuxt
1111

1212
[![npm version][npm-version-src]][npm-version-href]
1313
[![npm downloads][npm-downloads-src]][npm-downloads-href]
1414
[![License][license-src]][license-href]
1515
[![Nuxt][nuxt-src]][nuxt-href]
1616

17-
My new Nuxt module for doing amazing things.
18-
19-
- [ Release Notes](/CHANGELOG.md)
20-
<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/nuxt-queryref?file=playground%2Fapp.vue) -->
21-
<!-- - [📖 &nbsp;Documentation](https://example.com) -->
22-
2317
## Features
2418

2519
<!-- Highlight some of the features your module provide here -->
2620

27-
- &nbsp;Foo
28-
- 🚠 &nbsp;Bar
29-
- 🌲 &nbsp;Baz
21+
- Drop-in support instead of `ref()`
22+
- Supports all common types (string, number, boolean, Arrays, Objects)
23+
- Coherently typed for good DX
3024

3125
## Quick Setup
3226

@@ -36,7 +30,7 @@ Install the module to your Nuxt application with one command:
3630
npx nuxi module add nuxt-queryref
3731
```
3832

39-
That's it! You can now use My Module in your Nuxt app ✨
33+
That's it! You can now use `useQueryRef` in your Nuxt app ✨
4034

4135
## Contribution
4236

0 commit comments

Comments
 (0)