From 538bb43ba3df37b1f6b2411b1bddebf084c71503 Mon Sep 17 00:00:00 2001 From: gmpassos Date: Fri, 30 Jul 2021 06:16:50 -0300 Subject: [PATCH] v1.0.1 - Improve `pubspec.yaml` description. - Improve README. --- CHANGELOG.md | 5 +++++ README.md | 9 +++++++-- pubspec.yaml | 4 ++-- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index effe43c..d4b9fe2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +## 1.0.1 + +- Improve `pubspec.yaml` description. +- Improve README. + ## 1.0.0 - Initial version. diff --git a/README.md b/README.md index bb49b33..ef93a34 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,10 @@ [![Code size](https://img.shields.io/github/languages/code-size/gmpassos/yaml_writer?logo=github&logoColor=white)](https://github.com/gmpassos/yaml_writer) [![License](https://img.shields.io/github/license/gmpassos/yaml_writer?logo=open-source-initiative&logoColor=green)](https://github.com/gmpassos/yaml_writer/blob/master/LICENSE) -A library to write YAML documents. +A library to write YAML documents, supporting Object encoding and [dart:convert][dart_convert] [Converter][dart_converter]. + +[dart_convert]: https://api.dart.dev/stable/2.13.4/dart-convert/dart-convert-library.html +[dart_converter]: https://api.dart.dev/stable/2.13.4/dart-convert/Converter-class.html ## Usage @@ -57,10 +60,12 @@ avoiding to escape `"` and using `|` for multiline texts. ## Encoding Objects You can use `YAMLWriter.toEncodable` to convert an Object to an encodable version, -similar to what is done by `dart:convert` `JsonEncoder`. +similar to what is done by [dart:convert][dart_convert] [JsonEncoder][json_encoder]. If `YAMLWriter.toEncodable` is not set, it will try to call `toJson()`. +[json_encoder]: https://api.dart.dev/stable/2.13.4/dart-convert/JsonEncoder-class.html + ## Features and bugs Please file feature requests and bugs at the [issue tracker][tracker]. diff --git a/pubspec.yaml b/pubspec.yaml index a4c3fc3..1d3432f 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: yaml_writer -description: A library to write YAML documents. -version: 1.0.0 +description: A library to write YAML documents, supporting Object encoding and 'dart:convert' 'Converter'. +version: 1.0.1 homepage: https://github.com/gmpassos/yaml_writer environment: