Skip to content

Commit e74e90b

Browse files
committed
docs: add information
1 parent 02eb07b commit e74e90b

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

README.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
# Vuefire / Vuexfire [![Build Status](https://badgen.net/circleci/github/vuejs/vuefire)](https://circleci.com/gh/vuejs/vuefire)
22

3-
> Synchronize your data with a Firebase RTDB or Cloudstore
3+
> Synchronize your data and Firebase Cloud Store database in real-time
44
5-
This repository contains the code for `vuefire` and `vuexfire` packages:
5+
## Introduction
6+
7+
Firebase provides two solutions to handle real-time databases: Realtime Database and Cloud Store (which is also a realtime database).
8+
In order to keep all clients data in-sync with its cloud database, their [js SDK](https://firebase.google.com/docs/firestore/quickstart) provides the tools to do so. However, it quickly becomes bothersome to _bind_ multiple documents or collections to your application, keep them synchronized as well as handling [references](https://firebase.google.com/docs/firestore/manage-data/data-types) to other documents or collections, which can contain references themselves and must also be kept up to date.
9+
The goal of vuefire and vuexfire is to make this as simple as a function call that returns a promise so it is also easy to setup SSR and allows you to focus on developing your application.
10+
11+
<!-- TODO compare code samples -->
12+
13+
Note: _This repository contains the code for `vuefire` and `vuexfire` packages:_
614

715
## Packages
816

0 commit comments

Comments
 (0)