chore: dart 2.0.5 release changes (#6983)
authorIvan Dlugos <6349682+vaind@users.noreply.github.com>
Thu, 20 Jan 2022 21:30:03 +0000 (22:30 +0100)
committerGitHub <noreply@github.com>
Thu, 20 Jan 2022 21:30:03 +0000 (13:30 -0800)
dart/CHANGELOG.md
dart/README.md
dart/pubspec.yaml

index cfed9de..a582e2e 100644 (file)
@@ -1,4 +1,4 @@
-## 2.0.0
+## 2.0.5
 
 - switch to null safety (#6696)
 - add Object APIs (pack/unpack) (#6682, #6723, #6846)
index 312c1da..123cdc3 100644 (file)
@@ -2,10 +2,8 @@
 
 This package is used to read and write [FlatBuffers](https://google.github.io/flatbuffers/).
 
-Most consumers will want to use the [`flatc` - FlatBuffer compiler](https://github.com/google/flatbuffers) binary for your platform:
-* [Linux](https://github.com/google/flatbuffers/suites/4363603985/artifacts/114682272)
-* [macOS](https://github.com/google/flatbuffers/suites/4363603985/artifacts/114682273)
-* [Windows](https://github.com/google/flatbuffers/suites/4363603985/artifacts/114682274)
+Most consumers will want to use the [`flatc` - FlatBuffer compiler](https://github.com/google/flatbuffers) binary for your platform.
+You can find it in the `generator/{Platform}` directory of the [released package archive](https://pub.dev/packages/flat_buffers/versions/2.0.5.tar.gz).
 
 The FlatBuffer compiler `flatc` reads a FlatBuffers IDL schema and generates Dart code.
 The generated classes can be used to read or write binary data/files that are interoperable with
@@ -14,4 +12,12 @@ examples folder.
 
 For more details and documentation, head over to the official site and read the
 [Tutorial](https://google.github.io/flatbuffers/flatbuffers_guide_tutorial.html) and how to
-[use FlatBuffers in Dart](https://google.github.io/flatbuffers/flatbuffers_guide_use_dart.html).
\ No newline at end of file
+[use FlatBuffers in Dart](https://google.github.io/flatbuffers/flatbuffers_guide_use_dart.html).
+
+## Dart 2.0 notes
+Version 2.0.5 ships with it's own custom build of `flatc` because this is an extraordinary release to catch-up
+with FlatBuffers for other platforms. This generator can only generate dart code (to avoid generating code for other platforms which isn't released yet).
+On the other hand, the generated code still produces standard binary FlatBuffers compatible with other languages.
+In other words: only `flatc --dart ...` works with this generator, but your app will be able to produce and read standard binary (`Uint8List`) FlatBuffers that are fully compotible with other languages supporting FlatBuffers (e.g. Java, C++, ...).
+
+In the future a common `flatc` binary for all platforms would be shipped through GitHub release page instead.
index 5fe53b1..ae86570 100644 (file)
@@ -1,5 +1,5 @@
 name: flat_buffers
-version: 2.0.0
+version: 2.0.5
 description: FlatBuffers reading and writing library for Dart. Based on original work by Konstantin Scheglov and Paul Berry of the Dart SDK team.
 homepage: https://github.com/google/flatbuffers
 documentation: https://google.github.io/flatbuffers/index.html