Visitar URL original
[Pigeon] - updated the readme · flutter/packages@9be24fc · GitHub
Skip to content

Commit 9be24fc

Browse files
committed
[Pigeon] - updated the readme
1 parent 9d90dd3 commit 9be24fc

3 files changed

Lines changed: 12 additions & 7 deletions

File tree

‎packages/pigeon/CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## 0.1.2+1
2+
3+
* Updated the Readme.md.
4+
15
## 0.1.2
26

37
* Removed static analysis warnings from generated Java code.

‎packages/pigeon/README.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Pigeon
22

3-
**Warning: Pigeon is experimental and unsupported. It can be removed or changed
4-
at any time.**
3+
**Warning: Pigeon 1.0 hasn't shipped yet so breaking changes may happen still.**
54

65
Pigeon is a code generator tool to make communication between Flutter and the
76
host platform type-safe and easier.
87

98
## Supported Platforms
109

1110
Currently Pigeon only supports generating Objective-C code for usage on iOS and
12-
Java code for Android.
11+
Java code for Android. The Objective-C code is [accessible to Swift](https://developer.apple.com/documentation/swift/imported_c_and_objective-c_apis/importing_objective-c_into_swift) and the Java
12+
code is accessible to Kotlin.
1313

1414
## Runtime Requirements
1515

@@ -26,7 +26,7 @@ doesn't need to worry about conflicting versions of Pigeon.
2626
1) Run pigeon on your ".dart" file to generate the required Dart and Objective-C code.
2727
1) Add the generated Dart code to `lib` for compilation.
2828
1) Add the generated Objective-C code to your Xcode project for compilation
29-
(e.g. `ios/Runner.xcworkspace`).
29+
(e.g. `ios/Runner.xcworkspace` or `.podspec`).
3030
1) Implement the generated iOS protocol for handling the calls on iOS, set it up
3131
as the handler for the messages.
3232
1) Call the generated Dart methods.
@@ -44,7 +44,7 @@ doesn't need to worry about conflicting versions of Pigeon.
4444

4545
### Rules for defining your communication interface
4646

47-
1) The file should contain no method or function definitions.
47+
1) The file should contain no method or function definitions, only declarations.
4848
1) Datatypes are defined as classes with fields of the supported datatypes (see
4949
the supported Datatypes section).
5050
1) Api's should be defined as an `abstract class` with either `HostApi()` or
@@ -55,7 +55,8 @@ doesn't need to worry about conflicting versions of Pigeon.
5555

5656
## Example
5757

58-
See the "Example" tab.
58+
See the "Example" tab. A full working example can also be found in the
59+
[video_player plugin](https://github.com/flutter/plugins/tree/master/packages/video_player).
5960

6061
## Supported Datatypes
6162

‎packages/pigeon/pubspec.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: pigeon
2-
version: 0.1.2
2+
version: 0.1.2+1
33
description: Code generator tool to make communication between Flutter and the host platform type-safe and easier.
44
homepage: https://github.com/flutter/packages/tree/master/packages/pigeon
55
dependencies:

0 commit comments

Comments
 (0)