forked from firebase/flutterfire
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
FlutterFire plugin readme updates (firebase#56)
* Make plugin readmes more consistent. Add FlutterFire overview. * Make plugin readmes more consistent. Add FlutterFire overview. * Fix a broken link * Update 'in progress' note * Update 'in progress' note * Review feedback
- Loading branch information
Showing
10 changed files
with
102 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
# FlutterFire | ||
|
||
FlutterFire is a set of [Flutter plugins](https://flutter.io/platform-plugins/) | ||
that enable Flutter apps to use one or more [Firebase](https://firebase.google.com/) services. | ||
|
||
[Flutter](https://flutter.io) is a new mobile app SDK to help developers and | ||
designers build modern mobile apps for iOS and Android. | ||
|
||
*Note*: These plugins are part of the [Flutter open source project](https://github.com/flutter). | ||
The plugins are still under development, and some APIs might not be available yet. | ||
[Feedback](https://github.com/flutter/flutter/issues) and [Pull Requests](https://github.com/flutter/plugins/pulls) are most welcome! | ||
|
||
## Available FlutterFire plugins | ||
|
||
| Plugin | Firebase feature | Source code | | ||
|---|---|---| | ||
| [firebase_analytics][analytics_pub] | [Firebase Analytics][analytics_product] | [`packages/firebase_analytics`][analytics_code] | | ||
| [firebase_auth][auth_pub] | [Firebase Authentication][auth_product] | [`packages/firebase_auth`][auth_code] | | ||
| [firebase_database][database_pub] | [Firebase Realtime Database][database_product] | [`packages/firebase_database`][database_code] | | ||
| [firebase_messaging][messaging_pub] | [Firebase Cloud Messaging][messaging_product] | [`packages/firebase_messaging`][messaging_code] | | ||
| [firebase_storage][storage_pub] | [Firebase Cloud Storage][storage_product] | [`packages/firebase_storage`][storage_code] | | ||
|
||
[analytics_pub]: https://pub.dartlang.org/packages/firebase_analytics | ||
[analytics_product]: https://firebase.google.com/products/analytics/ | ||
[analytics_code]: https://github.com/flutter/plugins/tree/master/packages/firebase_analytics | ||
|
||
[auth_pub]: https://pub.dartlang.org/packages/firebase_auth | ||
[auth_product]: https://firebase.google.com/products/auth/ | ||
[auth_code]: https://github.com/flutter/plugins/tree/master/packages/firebase_auth | ||
|
||
[database_pub]: https://pub.dartlang.org/packages/firebase_database | ||
[database_product]: https://firebase.google.com/products/database/ | ||
[database_code]: https://github.com/flutter/plugins/tree/master/packages/firebase_database | ||
|
||
[messaging_pub]: https://pub.dartlang.org/packages/firebase_messaging | ||
[messaging_product]: https://firebase.google.com/products/cloud-messaging/ | ||
[messaging_code]: https://github.com/flutter/plugins/tree/master/packages/firebase_messaging | ||
|
||
[storage_pub]: https://pub.dartlang.org/packages/firebase_storage | ||
[storage_product]: https://firebase.google.com/products/storage/ | ||
[storage_code]: https://github.com/flutter/plugins/tree/master/packages/firebase_storage |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,7 @@ | ||
## 0.0.2 | ||
|
||
* Updated README.md | ||
|
||
## 0.0.1 | ||
|
||
* Initial Release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,7 @@ | ||
## 0.0.3 | ||
|
||
* Updated README.md | ||
|
||
## 0.0.2 | ||
|
||
* Bump buildToolsVersion to 25.0.3 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,14 @@ | ||
# firebase_auth | ||
# Firebase Authentication for Flutter | ||
|
||
[![pub package](https://img.shields.io/pub/v/firebase_auth.svg)](https://pub.dartlang.org/packages/firebase_auth) | ||
|
||
A new flutter plugin project. | ||
A Flutter plugin to use the [Firebase Authentication API](https://firebase.google.com/products/auth/). | ||
|
||
*Note*: This plugin is still under development, and some APIs might not be available yet. [Feedback](https://github.com/flutter/flutter/issues) and [Pull Requests](https://github.com/flutter/plugins/pulls) are most welcome! | ||
|
||
## Usage | ||
To use this plugin, add `firebase_auth` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/). | ||
|
||
## Getting Started | ||
|
||
For help getting started with Flutter, view our online | ||
[documentation](http://flutter.io/). | ||
See the `example` directory for a complete sample app using Firebase Authentication. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,7 @@ | ||
## 0.0.3 | ||
|
||
* Updated README.md | ||
|
||
## 0.0.2 | ||
|
||
* Fix compilation error | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,14 @@ | ||
# firebase_database | ||
# Firebase Realtime Database for Flutter | ||
|
||
[![pub package](https://img.shields.io/pub/v/firebase_database.svg)](https://pub.dartlang.org/packages/firebase_database) | ||
|
||
A new flutter plugin project. | ||
A Flutter plugin to use the [Firebase Realtime Database API](https://firebase.google.com/products/database/). | ||
|
||
*Note*: This plugin is still under development, and some APIs might not be available yet. [Feedback](https://github.com/flutter/flutter/issues) and [Pull Requests](https://github.com/flutter/plugins/pulls) are most welcome! | ||
|
||
## Usage | ||
To use this plugin, add `firebase_database` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/). | ||
|
||
## Getting Started | ||
|
||
For help getting started with Flutter, view our online | ||
[documentation](http://flutter.io/). | ||
See the `example` directory for a complete sample app using Firebase Realtime Database. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,29 @@ | ||
## v0.0.2+1 | ||
## 0.0.2+3 | ||
|
||
* Updated README.md | ||
|
||
## 0.0.2+2 | ||
|
||
* Updated README.md | ||
|
||
## 0.0.2+1 | ||
|
||
* Added workaround for https://github.com/flutter/flutter/issues/9694 to README | ||
* Moved code to https://github.com/flutter/plugins | ||
|
||
## v0.0.2 | ||
## 0.0.2 | ||
|
||
* Updated to latest plugin API | ||
|
||
## v0.0.1+2 | ||
## 0.0.1+2 | ||
|
||
* Downgraded gradle dependency for example app to make `flutter run` happy | ||
|
||
## v0.0.1+1 | ||
## 0.0.1+1 | ||
|
||
* Updated README with installation instructions | ||
* Added CHANGELOG | ||
|
||
## v0.0.1 | ||
## 0.0.1 | ||
|
||
* Initial Release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,14 @@ | ||
# firebase_storage | ||
# Firebase Cloud Storage for Flutter | ||
|
||
[![pub package](https://img.shields.io/pub/v/firebase_storage.svg)](https://pub.dartlang.org/packages/firebase_storage) | ||
|
||
A new flutter plugin project. | ||
A Flutter plugin to use the [Firebase Cloud Storage API](https://firebase.google.com/products/storage/). | ||
|
||
*Note*: This plugin is still under development, and some APIs might not be available yet. [Feedback](https://github.com/flutter/flutter/issues) and [Pull Requests](https://github.com/flutter/plugins/pulls) are most welcome! | ||
|
||
## Usage | ||
To use this plugin, add `firebase_storage` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/). | ||
|
||
## Getting Started | ||
|
||
For help getting started with Flutter, view our online | ||
[documentation](http://flutter.io/). | ||
See the `example` directory for a complete sample app using Firebase Cloud Storage. |