Skip to content

Commit

Permalink
FlutterFire plugin readme updates (firebase#56)
Browse files Browse the repository at this point in the history
* 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
mit-mit authored May 16, 2017
1 parent 971a672 commit 8dafeee
Show file tree
Hide file tree
Showing 10 changed files with 102 additions and 40 deletions.
41 changes: 41 additions & 0 deletions FlutterFire.md
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
4 changes: 4 additions & 0 deletions packages/firebase_analytics/CHANGELOG.md
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
13 changes: 6 additions & 7 deletions packages/firebase_analytics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,13 @@

[![pub package](https://img.shields.io/pub/v/firebase_analytics.svg)](https://pub.dartlang.org/packages/firebase_analytics)

**WARNING: this is incomplete and highly experimental**
A Flutter plugin to use the [Firebase Analytics API](https://firebase.google.com/docs/analytics/).

This plugin allows Flutter apps use the Firebase Analytics API from their Dart
code.
*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!

## Getting Started
## Usage
To use this plugin, add `firebase_analytics` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).

The the `example` directory for a sample app using Firebase Analytics.
## Getting Started

To learn more about Flutter plugins, view our online
[documentation](https://flutter.io/platform-plugins).
See the `example` directory for a complete sample app using Firebase Analytics.
4 changes: 4 additions & 0 deletions packages/firebase_auth/CHANGELOG.md
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
Expand Down
12 changes: 8 additions & 4 deletions packages/firebase_auth/README.md
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.
4 changes: 4 additions & 0 deletions packages/firebase_database/CHANGELOG.md
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
Expand Down
12 changes: 8 additions & 4 deletions packages/firebase_database/README.md
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.
18 changes: 13 additions & 5 deletions packages/firebase_messaging/CHANGELOG.md
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
22 changes: 6 additions & 16 deletions packages/firebase_messaging/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,18 @@

[![pub package](https://img.shields.io/pub/v/firebase_messaging.svg)](https://pub.dartlang.org/packages/firebase_messaging)

**WARNING: This is incomplete and experimental.**

This plugin allows Flutter apps to interact with the [Firebase Cloud Messaging (FCM) API](https://firebase.google.com/docs/cloud-messaging/) from Dart code.
A Flutter plugin to use the [Firebase Cloud Messaging (FCM) API](https://firebase.google.com/docs/cloud-messaging/).

With this plugin, your Flutter app can receive and process push notifications as well as data messages on Android and iOS. Read Firebase's [About FCM Messages](https://firebase.google.com/docs/cloud-messaging/concept-options) to learn more about the differences between notification messages and data messages.

Not all features of the API are implemented in the plugin yet. If something is missing feel free to send a [pull request](https://github.com/flutter/plugins/pull/new/master) or file an [issue](https://github.com/flutter/flutter/issues/new).

## Getting Started

Check out the `example` directory for a sample app that uses this plugin. To learn more about Flutter plugins in general, view our [online documentation](https://flutter.io/platform-plugins).
*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!

### Add the Plugin
## Usage
To use this plugin, add `firebase_messaging` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).

Open the `pubspec.yaml` file of your app and under `dependencies` add a line for this plugin:

```yaml
dependencies:
firebase_messaging: <version you want to depend on>
```
## Getting Started

You can find the most recent version of the plugin on [pub](https://pub.dartlang.org/packages/firebase_messaging).
Check out the `example` directory for a sample app using Firebase Cloud Messaging.

### Android Integration

Expand Down
12 changes: 8 additions & 4 deletions packages/firebase_storage/README.md
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.

0 comments on commit 8dafeee

Please sign in to comment.