From 41f70ab3b1def6dab3df81749253e5b4891ecd06 Mon Sep 17 00:00:00 2001 From: Siarhei Dudko Date: Fri, 3 Nov 2023 14:21:25 +0400 Subject: [PATCH] change readme --- README.md | 20 ++++++++++---------- package.json | 4 ++-- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d81294d5..d48f20ca 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/package.json b/package.json index 0de8f767..5e2f4bc1 100644 --- a/package.json +++ b/package.json @@ -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": { @@ -37,7 +37,7 @@ "cli", "mobile" ], - "author": "Siarhei Dudko ", + "author": "Siarhei Dudko ", "funding": [ { "type": "buymeacoffee",