| 1 | # @firebase/firestore
|
| 2 |
|
| 3 | This is the [Cloud Firestore](https://firebase.google.com/docs/firestore/) component of the
|
| 4 | [Firebase JS SDK](https://www.npmjs.com/package/firebase).
|
| 5 |
|
| 6 | **This package is not intended for direct usage, and should only be used via the officially
|
| 7 | supported [firebase](https://www.npmjs.com/package/firebase) package.**
|
| 8 |
|
| 9 | If you are developing a Node.js application that requires administrative access to Cloud Firestore,
|
| 10 | use the [`@google-cloud/firestore`](https://www.npmjs.com/package/@google-cloud/firestore) Server
|
| 11 | SDK with your developer credentials.
|
| 12 |
|
| 13 | ## Documentation
|
| 14 |
|
| 15 | For comprehensive documentation please see the [Firebase Reference
|
| 16 | Docs][reference-docs].
|
| 17 |
|
| 18 | [reference-docs]: https://firebase.google.com/docs/reference/js/
|
| 19 |
|
| 20 | ## Contributing
|
| 21 | See [Contributing to the Firebase SDK](../../CONTRIBUTING.md) for general
|
| 22 | information about contributing to the firebase-js-sdk repo and
|
| 23 | [Contributing to the Cloud Firestore Component](./CONTRIBUTING.md) for
|
| 24 | details specific to the Cloud Firestore code and tests.
|