Version 3.0.0 release preps

alexei-sintotski · Nov 6, 2021 · 1212d8c · 1212d8c
1 parent f174ec6
commit 1212d8c
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 14 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## [3.0.0] - Rewrite for output correctness and beautification
+* Complete rewrite of YAML formatter
+* Correct handling of nested structures
+* Built-in automatic beautifier
+* Improved support of Dart pubspec file formats with dedicated test suites
+
 ## [2.0.0] - Migrated to null safety
 * Kudos to https://github.com/spkersten for help!
 

diff --git a/README.md b/README.md
@@ -1,5 +1,15 @@
 # json2yaml [![Build Status](https://travis-ci.com/alexei-sintotski/json2yaml.svg?branch=master)](https://travis-ci.com/alexei-sintotski/json2yaml) [![codecov](https://codecov.io/gh/alexei-sintotski/json2yaml/branch/master/graph/badge.svg)](https://codecov.io/gh/alexei-sintotski/json2yaml) [![pubspec_lock version](https://img.shields.io/pub/v/json2yaml?label=json2yaml)](https://pub.dev/packages/json2yaml)
-Dart package to render JSON data to YAML
+
+Dart package to render JSON data to YAML:
+* Correct handling of nested structures
+* Built-in automatic beautifer
+* Supports Dart pubspec.yaml conventions
+* Compatible with conventions imposed by Dart pubspec.lock generator
+
+## Known limitations
+
+* Strings (single line and multiline) are always formatted as they are,
+without word wrapping for better human readability
 
 ## json2yaml()
 
@@ -23,17 +33,6 @@ json2yaml is the function to format JSON data to YAML.
   print(json2yaml(developerData));
 ```
 
-This function is implemented in a very basic and perhaps naive way, please let me know if it does not work for you.
-
-## Usage
-
-To use json2yaml, add the following dependency to pubspec.yaml:
-
-```
-dependencies:
-  json2yaml: ^1.0.0
-```
-
 ## Advanced usage: YAML formatting styles
 
 json2yaml supports the optional argument to customize YAML formatting for various use cases.

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,11 @@
 name: json2yaml
-description: Dart package to format JSON data to YAML. Supports formatting conventions of pubspec files.
-version: 2.0.0
+description: |-
+  Dart package to render JSON data to YAML:
+  * Correct handling of nested structures
+  * Built-in automatic beautifer
+  * Supports Dart pubspec.yaml conventions
+  * Compatible with conventions imposed by Dart pubspec.lock generator
+version: 3.0.0
 homepage: https://github.com/alexei-sintotski/json2yaml
 
 environment: