Skip to content

Commit b5662e8

Browse files
committed
chore: update readme
1 parent a7f500d commit b5662e8

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,32 @@
1111
</p>
1212
<br/>
1313

14-
> Synchronize your data and Firebase Cloud Store database in real-time
14+
> Firebase for Vue made easy!
1515
16-
- Works with Vue 2 and Vue 3
17-
- Supports Composition API
18-
- Supports Vuex & Pinia
16+
- Works with Vue >=2.7 and Vue 3
17+
- Supports Composition and Options API
18+
- Supports Vuex, Pinia, and anything that gives you a Vue `ref()`
1919
- Built for Firebase 9 for optimal tree shaking
2020
- Automatically listen for changes in nested references
2121

22-
[**Documentation**](https://vuefire.vuejs.org)
22+
[**WIP 📚 Documentation**](https://main--vuefire.netlify.app/)
23+
24+
## Roadmap
25+
26+
VueFire is currently being rewritten to support Vue 3 and Firebase 9. You can follow the progress on [the Roadmap issue](https://github.com/vuejs/vuefire/issues/1241).
2327

2428
## Installation
2529

30+
VueFire requires the `firebase` package to be installed as well as `vuefire`:
31+
2632
```bash
2733
npm install vuefire@edge
2834
```
2935

36+
## Usage
37+
38+
[Getting Started](https://main--vuefire.netlify.app/guide/getting-started.html)
39+
3040
## Related
3141

3242
- [Firebase Web Docs](https://firebase.google.com/docs/web/setup)

0 commit comments

Comments
 (0)