Bump to 1.3.0 (#20)

* Add missing documentation (fix #19) * Add contributors section to README * Bump to 1.3.0
fujidaiti · Feb 7, 2024 · 894ada9 · 894ada9
1 parent c18e393
commit 894ada9
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 8 deletions.
diff --git a/embed/CHANGELOG.md b/embed/CHANGELOG.md
@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.3.0
+
+- Update `toml` dependency to 0.15.0 (#17 by @bramp)
+- Required Dart SDK version is now 3.2 or higher
+
 ## 1.2.0
 
 - New feature: embedding binary contents (#13 by @NicolaVerbeeck)

diff --git a/embed/README.md b/embed/README.md
@@ -177,12 +177,13 @@ You can find many more examples in the following resources:
 
 ## How to use
 
-Currently, there are 2 types of embedding methods:
+Currently, there are 3 types of embedding methods:
 
 - [Embed a text content as a String literal](#embed-a-text-content-as-a-string-literal)
+- [Embed contents as binary](#embed-contents-as-binary)
 - [Embed a structured data as a Dart object](#embed-a-structured-data-as-a-dart-object)
 
-What content to embed and how to embed it can be described using predefined annotations. For example, you can use the `EmbedStr` annotation to embed a text content as a string literal. Note that only top-level variables can be annotated, as shown below:
+What content to embed and how to embed it can be described using predefined annotations. For example, you can use the `EmbedStr` annotation to embed text content as a string literal. Note that only top-level variables can be annotated, as shown below:
 
 ```dart
 @EmbedStr(...) // This is OK
@@ -430,6 +431,15 @@ flutter clean && flutter pub run build_runner build
 
 <br/>
 
+## Contributors
+
+Thanks to all the contributors!
+
+- [@NicolaVerbeeck](https://github.com/NicolaVerbeeck): Support embedding binary files ([#13](https://github.com/fujidaiti/embed.dart/pull/13))
+- [@bramp](https://github.com/bramp): Bumped the toml and lint dependencies to their latest([#17](https://github.com/fujidaiti/embed.dart/pull/17))
+
+<br/>
+
 ## Contributing
 
 Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

diff --git a/embed/pubspec.yaml b/embed/pubspec.yaml
@@ -1,6 +1,6 @@
 name: embed
 description: Code generation for embedding arbitrary file content into Dart code.
-version: 1.2.0
+version: 1.3.0
 repository: https://github.com/fujidaiti/embed.dart.git
 
 environment:

diff --git a/embed_annotation/CHANGELOG.md b/embed_annotation/CHANGELOG.md
@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## 1.2.1
+
+- Documentation updates
+
 ## 1.2.0
 
 - Added a new annotation for embedding binary contents (#13 by @NicolaVerbeeck)

diff --git a/embed_annotation/lib/embed_annotation.dart b/embed_annotation/lib/embed_annotation.dart
@@ -1,12 +1,11 @@
 library embed_annotation;
 
-/// Base class for the all annotation classes
-/// that configures how content is embedded.
+/// Base class for the all annotation classes that configures how content is embedded.
 ///
-/// Use the one of the folowing subclasses to
-/// configure how content should be embedded.
+/// Use the one of the following subclasses to configure how content should be embedded.
 ///
 /// * [EmbedStr] : For embedding a text content as a string literal.
+/// * [EmbedBinary] : For embedding a binary data as an integer list or a base64 string.
 /// * [EmbedLiteral] : For embedding a structured data as a dart object.
 ///
 /// Only top level elements can be annotated with these annotations.

diff --git a/embed_annotation/pubspec.yaml b/embed_annotation/pubspec.yaml
@@ -1,6 +1,6 @@
 name: embed_annotation
 description: A package exposing annotations for embed.
-version: 1.2.0
+version: 1.2.1
 repository: https://github.com/fujidaiti/embed.dart.git
 
 environment: