Skip to content

Commit

Permalink
change readme
Browse files Browse the repository at this point in the history
  • Loading branch information
siarheidudko committed Nov 3, 2023
1 parent 53a3a0c commit 41f70ab
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# firebase-engine

Engine to Backup, Clean, Restore. Work for Firebase.Firestore, Firebase.Storage, Firebase.Auth
Unlock Peak Performance for Your Firebase Project: A Dynamic Engine for Effortless Backup, Thorough Cleaning, and Seamless Restoration. Tailored for Firebase Firestore, Firebase Storage, and Firebase Auth. Streamline Your Workflow with Unrivaled Efficiency!

[![npm](https://img.shields.io/npm/v/firebase-engine.svg)](https://www.npmjs.com/package/firebase-engine)
[![npm](https://img.shields.io/npm/dy/firebase-engine.svg)](https://www.npmjs.com/package/firebase-engine)
Expand All @@ -11,7 +11,7 @@ Engine to Backup, Clean, Restore. Work for Firebase.Firestore, Firebase.Storage,
## Install

```bash
npm i firebase-engine -g
npm i firebase-engine -g
```

## Launch parameters
Expand Down Expand Up @@ -44,31 +44,31 @@ Engine to Backup, Clean, Restore. Work for Firebase.Firestore, Firebase.Storage,
With full names

```bash
firebase-engine operations="clean, restore" path="./test.json" services="firestore, storage" backup="test.backup"
firebase-engine operations="clean, restore" path="./test.json" services="firestore, storage" backup="test.backup"
```

With one bucket

```bash
firebase-engine operations="clean" path="./test.json" services="storage" buckets="test.appspott.com"
firebase-engine operations="clean" path="./test.json" services="storage" buckets="test.appspott.com"
```

With collection & subcollection

```bash
firebase-engine operations="backup" path="./test.json" services="firestore" collections="authors,books.pages"
firebase-engine operations="backup" path="./test.json" services="firestore" collections="authors,books.pages"
```

With short names and use emulators

```bash
firebase-engine o="b, c" s="f" p="./test.json" b="test.backup" -em
firebase-engine o="b, c" s="f" p="./test.json" b="test.backup" -em
```

With password recovery for users

```bash
firebase-engine operations="restore" path="./test.json" services="firestore, auth" backup="test.backup" bsk="nMyNs6sFWp0GZ/JSW2tsNGvGZ70oiv13gxO7ub7rxPwK271P945BiZmjrdsBRbgZmzPPgwATLR6FaXq3rUspVg=="
firebase-engine operations="restore" path="./test.json" services="firestore, auth" backup="test.backup" bsk="nMyNs6sFWp0GZ/JSW2tsNGvGZ70oiv13gxO7ub7rxPwK271P945BiZmjrdsBRbgZmzPPgwATLR6FaXq3rUspVg=="
```

## Copy data from project to emulators or from emulators to project
Expand All @@ -82,13 +82,13 @@ With password recovery for users
With full names

```bash
firebase-engine-emulators path="./test.json" --to-emulators
firebase-engine-emulators path="./test.json" --to-emulators
```

With short names

```bash
firebase-engine-emulators p="./test.json" -from
firebase-engine-emulators p="./test.json" -from
```

## Open Source
Expand Down Expand Up @@ -116,7 +116,7 @@ I recommend using only the top collection level in the collections parameter. Be
To a full database cleanup, including shadow documents, use the command in firebase tools

```bash
firebase firestore:delete -r
firebase firestore:delete -r
```

## LICENSE
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "firebase-engine",
"version": "1.5.103",
"description": "Tools for firebase (backup, clean, restore)",
"description": "Engine for Backup, Clean and Restore your Firebase Project data",
"main": "./lib/index.js",
"types": "./lib/index.d.ts",
"scripts": {
Expand Down Expand Up @@ -37,7 +37,7 @@
"cli",
"mobile"
],
"author": "Siarhei Dudko <[email protected]>",
"author": "Siarhei Dudko <[email protected]>",
"funding": [
{
"type": "buymeacoffee",
Expand Down

0 comments on commit 41f70ab

Please sign in to comment.