Skip to content

Commit

Permalink
Fix platform interface readme (#429)
Browse files Browse the repository at this point in the history
* fix link to repo for platform interface

* add readme for platform interface

* add readme for the repository
  • Loading branch information
MaikuB authored Jan 7, 2020
1 parent 6f25d67 commit a997153
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 12 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# flutter_local_notifications
A Flutter plugin for displaying local notifications on Android and iOS. The repository consists of the following folders

- flutter_local_notifications: code for the plugin
- flutter_local_notifications: the code for common platform interface
4 changes: 4 additions & 0 deletions flutter_local_notifications_platform_interface/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## [1.0.0+1]
* Fix link to repo in pubspec
* Update readme

## [1.0.0]

* Initial release of platform interface
13 changes: 3 additions & 10 deletions flutter_local_notifications_platform_interface/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
# flutter_local_notifications_platform_interface

A new Flutter package project.
A common platform interface for the [`flutter_local_notifications`](https://pub.dev/packages/flutter_local_notifications) plugin.

## Getting Started
## Usage

This project is a starting point for a Dart
[package](https://flutter.dev/developing-packages/),
a library module containing code that can be shared easily across
multiple Flutter or Dart projects.

For help getting started with Flutter, view our
[online documentation](https://flutter.dev/docs), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
Platform-specific implementations should extend from the `FlutterLocalNotificationsPlatform` class. Upon registering the plugin, the default implementation `FlutterLocalNotificationsPlatform` can be set by calling `FlutterLocalNotificationsPlatform.instance = MyFlutterLocalNotificationsPlatform()` where `MyFlutterLocalNotificationsPlatform()` represents the platform-specific implementation.
4 changes: 2 additions & 2 deletions flutter_local_notifications_platform_interface/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: flutter_local_notifications_platform_interface
description: A common platform interface for the flutter_local_notifications plugin.
version: 1.0.0
homepage: https://github.com/MaikuB/flutter_local_notifications/flutter_local_notifications_platform_interface
version: 1.0.0+1
homepage: https://github.com/MaikuB/flutter_local_notifications/tree/master/flutter_local_notifications_platform_interface

environment:
sdk: ">=2.1.0 <3.0.0"
Expand Down

0 comments on commit a997153

Please sign in to comment.