Skip to content

Update README with context, contributing, and license sections #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 16, 2017
Merged

Update README with context, contributing, and license sections #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

```
Expand Down Expand Up @@ -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/).