Skip to content

Commit

Permalink
v1.0.1
Browse files Browse the repository at this point in the history
- Improve `pubspec.yaml` description.
- Improve README.
  • Loading branch information
gmpassos committed Jul 30, 2021
1 parent 2637a74 commit 538bb43
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
## 1.0.1

- Improve `pubspec.yaml` description.
- Improve README.

## 1.0.0

- Initial version.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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].
Expand Down
4 changes: 2 additions & 2 deletions pubspec.yaml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down

0 comments on commit 538bb43

Please sign in to comment.