Skip to content

Commit be3d498

Browse files
posvaposva
committed
chore: updates to readme
1 parent 6571605 commit be3d498

File tree

3 files changed

+76
-3
lines changed

3 files changed

+76
-3
lines changed

Diff for: ‎README.md

+74-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,77 @@
1-
# vuefire [![Build Status](https://badgen.net/circleci/github/posva/vuefire/master)](https://circleci.com/gh/posva/vuefire) [![npm package](https://badgen.net/npm/v/vuefire)](https://www.npmjs.com/package/vuefire) [![coverage](https://badgen.net/codecov/c/github/posva/vuefire/master)](https://codecov.io/github/posva/vuefire) [![thanks](https://badgen.net/badge/thanks/♥/pink)](https://github.com/posva/thanks)
1+
<p align="center"><a href="https://vuefire.vuejs.org" target="_blank" rel="noopener noreferrer"><img width="100" src="https://vuefire.vuejs.org/vuefire-logo.svg" alt="VueFire logo"></a></p>
2+
3+
<h1 align="center">Vuefire</h1>
4+
<p align="center">
5+
<a href="https://circleci.com/gh/vuejs/vuefire"><img src="https://badgen.net/circleci/github/vuejs/vuefire/v3" alt="Build Status"></a>
6+
<a href="https://codecov.io/github/vuejs/vuefire"><img src="https://badgen.net/codecov/c/github/vuejs/vuefire/v3" alt="Build Status"></a>
7+
</p>
8+
9+
> Synchronize your data and Firebase Cloud Store database in real-time
10+
11+
- Works with Vue 2 and Vue 3
12+
- Supports Composition API
13+
- Supports Vuex
14+
- Automatically listen for changes in nested references
15+
16+
Note: This version currently supports Firebase 7. Support for Firebase 8 is on the way.
17+
18+
[**Documentation**](https://vuefire.vuejs.org)
19+
20+
## Introduction
21+
22+
Firebase provides two solutions to handle real-time databases: Realtime Database
23+
and Cloud Store (which is also a realtime database). In order to keep all
24+
clients data in-sync with its cloud database, their [js
25+
SDK](https://firebase.google.com/docs/firestore/quickstart) provides the tools
26+
to do so. However, it quickly becomes bothersome to _bind_ multiple documents or
27+
collections to your application, keep them synchronized as well as handling
28+
[references](https://firebase.google.com/docs/firestore/manage-data/data-types)
29+
to other documents or collections, which can contain references themselves and
30+
must also be kept up to date. The goal of Vuefire is to make this as simple as a
31+
function call that returns a promise so it is also easy to setup SSR and allows
32+
you to focus on developing your application.
33+
34+
To better understand why Vuefire will make it so much easier to develop Vue apps
35+
with firebase, please, check [this link in the
36+
documentation](https://vuefire.vuejs.org/vuefire/#why)
37+
38+
## Related
39+
40+
- [Firebase Web Docs](https://firebase.google.com/docs/web/setup)
41+
- [Realtime database](https://firebase.google.com/docs/database/)
42+
- [Cloud Firestore](https://firebase.google.com/docs/firestore/) (You should try this one which is also realtime)
43+
44+
## License
45+
46+
[MIT](http://opensource.org/licenses/MIT)
47+
48+
## Sponsors
49+
50+
**Help me keep working on Open Source in a sustainable way 🚀**. Help me with as little as \$1 a month, [sponsor me on Github](https://github.com/sponsors/posva).
51+
52+
<h3 align="center">Silver Sponsors</h3>
53+
54+
<p align="center">
55+
<a href="https://www.vuemastery.com" title="Vue Mastery" target="_blank">
56+
<img src="https://www.vuemastery.com/images/lgo-vuemastery.svg" alt="Vue Mastery logo" height="48px">
57+
</a>
58+
</p>
59+
60+
<p align="center">
61+
<a href="https://vuetifyjs.com" target="_blank" title="Vuetify">
62+
<img src="https://vuejs.org/images/vuetify.png" alt="Vuetify logo" height="48px">
63+
</a>
64+
</p>
65+
66+
<h3 align="center">Bronze Sponsors</h3>
67+
68+
<p align="center">
69+
<a href="https://www.storyblok.com" target="_blank" title="Storyblok">
70+
<img src="https://a.storyblok.com/f/51376/3856x824/fea44d52a9/colored-full.png" alt="Storyblok logo" height="32px">
71+
</a>
72+
</p>
73+
74+
---
275

376
> Some awesome description
477

Diff for: ‎examples/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<title>VueFire Todo App Demo</title>
66
<script src="https://www.gstatic.com/firebasejs/7.24.0/firebase.js"></script>
77
<script src="https://unpkg.com/vue@3"></script>
8-
<script src="../dist/vuefire.global.js"></script>
8+
<script src="../dist/vuefire.global-vue-3.js"></script>
99
</head>
1010

1111
<body>

Diff for: ‎examples/rtdb.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<title>VueFire Todo App Demo</title>
66
<script src="https://www.gstatic.com/firebasejs/7.24.0/firebase.js"></script>
77
<script src="https://unpkg.com/vue@3"></script>
8-
<script src="../dist/vuefire.global.js"></script>
8+
<script src="../dist/vuefire.global-vue-3.js"></script>
99
</head>
1010
<body>
1111
<!--

0 commit comments

Comments
 (0)