aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Paul Beusterien <paulbeusterien@google.com>2017-05-16 10:48:38 -0700
committerGravatar GitHub <noreply@github.com>2017-05-16 10:48:38 -0700
commit30fd0d81df47a00eb015d5b9ca4f58811e513d88 (patch)
tree420318769dc7b551359bcb00f120115b243be62f /README.md
parentdcd4d549e00a0349d8f910b22cecfb979ba719d7 (diff)
Update README with context, contributing, and license sections (#3)
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
index 717e014..35767b1 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,21 @@ interested in contributing to Firebase.
General Firebase information can be found at [https://firebase.google.com](https://firebase.google.com).
+## Context
+
+This repo contains a fully functional development environment for FirebaseCore,
+FirebaseAuth, FirebaseDatabase, FirebaseMessaging, and FirebaseStorage. By
+following the usage instructions below, they can be developed and debugged with
+unit tests, integration tests, and reference samples.
+
+Note, however, that the resulting FirebaseDev pod is NOT interoperable with the
+official Firebase release pods because of different pod dependency definitions.
+
+Instructions and a script to build replaceable static library
+frameworks at [BuildFrameworks](BuildFrameworks). The
+resulting frameworks can be used to replace frameworks delivered by CocoaPods or
+the zip distribution for development.
+
## Usage
```
@@ -63,3 +78,16 @@ Push notifications can only be delivered to specially provisioned App IDs in the
### iOS Simulator
The iOS Simulator cannot register for remote notifications, and will not receive push notifications. In order to receive push notifications, you'll have to follow the steps above and run the app on a physical device.
+
+## Contributing
+
+See [Contributing](CONTRIBUTING.md) for more information on contributing to the Firebase
+JavaScript SDK.
+
+## License
+
+The contents of this repository is licensed under the
+[Apache License, version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+
+Your use of Firebase is governed by the
+[Terms of Service for Firebase Services](https://firebase.google.com/terms/).