summaryrefslogtreecommitdiff
path: root/frontend-old/node_modules/@firebase/firestore/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'frontend-old/node_modules/@firebase/firestore/README.md')
-rw-r--r--frontend-old/node_modules/@firebase/firestore/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/frontend-old/node_modules/@firebase/firestore/README.md b/frontend-old/node_modules/@firebase/firestore/README.md
new file mode 100644
index 0000000..504f6ab
--- /dev/null
+++ b/frontend-old/node_modules/@firebase/firestore/README.md
@@ -0,0 +1,24 @@
+# @firebase/firestore
+
+This is the [Cloud Firestore](https://firebase.google.com/docs/firestore/) component of the
+[Firebase JS SDK](https://www.npmjs.com/package/firebase).
+
+**This package is not intended for direct usage, and should only be used via the officially
+supported [firebase](https://www.npmjs.com/package/firebase) package.**
+
+If you are developing a Node.js application that requires administrative access to Cloud Firestore,
+use the [`@google-cloud/firestore`](https://www.npmjs.com/package/@google-cloud/firestore) Server
+SDK with your developer credentials.
+
+## Documentation
+
+For comprehensive documentation please see the [Firebase Reference
+Docs][reference-docs].
+
+[reference-docs]: https://firebase.google.com/docs/reference/js/
+
+## Contributing
+See [Contributing to the Firebase SDK](../../CONTRIBUTING.md) for general
+information about contributing to the firebase-js-sdk repo and
+[Contributing to the Cloud Firestore Component](./CONTRIBUTING.md) for
+details specific to the Cloud Firestore code and tests.