From be18033461bf2b4587b33d8045d84fffc338194b Mon Sep 17 00:00:00 2001 From: Felix Krause Date: Sun, 10 Jul 2022 23:24:25 +0200 Subject: [PATCH] updated changelog & readme, v1.0.0 --- CHANGELOG.md | 6 ++++-- README.md | 14 +++++++------- nimdoc.cfg | 19 ++++++++++--------- yaml.nimble | 2 +- 4 files changed, 22 insertions(+), 19 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7e2cd99..65bab27 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -## 1.0.0 (upcoming) +## 1.0.0 Features: @@ -6,11 +6,13 @@ Features: and can be used to hold substructures that should not be deserialized to native types (#48). -Bufgixes: +Bugfixes: * Raise a proper exception when a stream contains no documents but one is expected (#108) * Comments after a block scalar do not lead to a crash anymore (#106) + * Fixed an error with parsing document end markers (#115) + * Fixed an error when serializing block scalars (#105) ## 0.16.0 diff --git a/README.md b/README.md index ebff3f4..37e316e 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,7 @@ NimYAML is a pure Nim YAML implementation without any dependencies other than Nim's standard library. It enables you to serialize Nim objects to a YAML stream -and back. It also provides a low-level event-based API, and a document object -model which you do not want to use because serializing to native types is much -more awesome. +and back. It also provides a low-level event-based API. Documentation, examples and an online demo are available [here][1]. Releases are available as tags in this repository and can be fetched via nimble: @@ -15,8 +13,10 @@ available as tags in this repository and can be fetched via nimble: ## Status -The library is fairly stable, I only maintain it and will not add any features due to lack of time and interest. NimYAML passes all tests of the current YAML -test suite which makes it 100% conformant with YAML 1.2. +This library is stable. +I only maintain it and will not add any features due to lack of time and interest. +NimYAML passes almost all tests of the current YAML 1.2 test suite and is currently lacking in few exotic edge-cases. +See [the official YAML test matrix][4] for details. PRs for bugs are welcome. If you want to add a feature, you are free to; but be aware that I will not maintain it and am unlikely to review it in depth, so if I accept it, you will be co-maintainer. @@ -42,7 +42,6 @@ nim build # build a library NimYAML supports Nim 1.4.0 and later. Previous versions are untested. -NimYAML v0.9.1 is the last release to support Nim 0.15.x and 0.16.0. When debugging crashes in this library, use the `d:debug` compile flag to enable printing of the internal stack traces for calls to `internalError` and `yAssert`. @@ -70,4 +69,5 @@ If you like this project and want to give something back, you can check out GitH [1]: http://flyx.github.io/NimYAML/ [2]: copying.txt - [3]: https://nixos.wiki/wiki/Flakes \ No newline at end of file + [3]: https://nixos.wiki/wiki/Flakes + [4]: https://matrix.yaml.info/ diff --git a/nimdoc.cfg b/nimdoc.cfg index 0b75622..a28fdc4 100644 --- a/nimdoc.cfg +++ b/nimdoc.cfg @@ -121,15 +121,16 @@ doc.file = """ Modules diff --git a/yaml.nimble b/yaml.nimble index d123545..236bebb 100644 --- a/yaml.nimble +++ b/yaml.nimble @@ -1,6 +1,6 @@ # Package -version = "0.16.0" +version = "1.0.0" author = "Felix Krause" description = "YAML 1.2 implementation for Nim" license = "MIT"