Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #1239

Closed
wants to merge 2 commits into from
Closed

Update README.md #1239

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e849b3f
Update README.md
evolvedhat Jul 13, 2022
b894b6a
Merge pull request #1 from evolvedhat/evolvedhat-patch-1
evolvedhat Jul 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,27 @@ Note: _This repository contains the code for `vuefire` and `vuexfire` packages:_
[\@posva/vuefire-core-package]: https://npmjs.com/package/@posva/vuefire-core
[\@posva/vuefire-test-helpers-package]: https://npmjs.com/package/@posva/vuefire-test-helpers

## Getting Started


In order to get started make sure to install the latest version of `vuefire` as well as `firebase`:

``yarn add vuefire firebase``

or

``npm install vuefire firebase``

## Plugin

Vuefire must be installed as a Vue plugin. Make sure to install the right one:

* Install `firestorePlugin` if you need to use Cloud Firestore (often abreviated *Firestore*)
* Install `rtdbPlugin` if you need to use the original *RTDB* (Real Time Database)
* If you need to use both, check [Using RTDB and Firestore together](https://vuefire.vuejs.org/cookbook/rtdb-and-firestore.html)

For more details on usage visit https://vuefire.vuejs.org/vuefire/getting-started.html#installation

## Related

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