mirror of https://github.com/status-im/NimYAML.git
NimYAML 0.6.0
This commit is contained in:
parent
280f0d6ce2
commit
eab44a99ed
12
CHANGELOG.md
12
CHANGELOG.md
|
@ -1,3 +1,15 @@
|
||||||
|
### 0.6.0
|
||||||
|
|
||||||
|
Features:
|
||||||
|
|
||||||
|
* Properly support variant object types
|
||||||
|
* First version that works with a released Nim version (0.14.0)
|
||||||
|
|
||||||
|
Bugfixes:
|
||||||
|
|
||||||
|
* Fixed a crash in presenter when outputting JSON or canonical YAML
|
||||||
|
* Raise an exception when trying to output multiple documents in JSON style
|
||||||
|
|
||||||
### 0.5.1
|
### 0.5.1
|
||||||
|
|
||||||
Bugfixes:
|
Bugfixes:
|
||||||
|
|
33
README.md
33
README.md
|
@ -1,19 +1,24 @@
|
||||||
# NimYAML - YAML implementation for Nim
|
# NimYAML - YAML implementation for Nim
|
||||||
|
|
||||||
NimYAML is currently being developed. The current release 0.5.1 is not
|
NimYAML is a pure Nim YAML implementation without any dependencies other than
|
||||||
considered stable. See [the documentation](http://flyx.github.io/NimYAML/) for
|
Nim's standard library. It enables you to serialize Nim objects to a YAML stream
|
||||||
an overview of already available features.
|
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.
|
||||||
|
|
||||||
## TODO list
|
Documentation, examples and an online demo are available [here][1]. Releases are
|
||||||
|
available as tags in this repository and can be fetched via nimble:
|
||||||
|
|
||||||
|
nimble install yaml
|
||||||
|
|
||||||
|
## Features that may come in the future
|
||||||
|
|
||||||
* Misc:
|
|
||||||
- Add type hints for more scalar types
|
|
||||||
* Serialization:
|
* Serialization:
|
||||||
- Support for more standard library types
|
- Support for more standard library types
|
||||||
- Support polymorphism
|
- Support for polymorphism
|
||||||
- Support generic objects
|
- Support for generic objects
|
||||||
- Support transient fields (i.e. fields that will not be (de-)serialized on
|
- Support for transient fields (i.e. object fields that will not be
|
||||||
objects and tuples)
|
(de-)serialized
|
||||||
|
|
||||||
## Developers
|
## Developers
|
||||||
|
|
||||||
|
@ -29,9 +34,11 @@ nim build # build a library
|
||||||
nim yamlTestSuite # execute YAML test suite (git-clones yaml-dev-kit)
|
nim yamlTestSuite # execute YAML test suite (git-clones yaml-dev-kit)
|
||||||
```
|
```
|
||||||
|
|
||||||
Project is tested against current develop branch of Nim. Older Nim versions
|
NimYAML needs at least Nim 0.14.0 in order to compile.
|
||||||
do not work.
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
[MIT](copying.txt)
|
[MIT][2]
|
||||||
|
|
||||||
|
[1]: http://flyx.github.io/NimYAML/
|
||||||
|
[2]: copying.txt
|
|
@ -1,10 +1,10 @@
|
||||||
# Package
|
# Package
|
||||||
|
|
||||||
version = "0.5.1"
|
version = "0.6.0"
|
||||||
author = "Felix Krause"
|
author = "Felix Krause"
|
||||||
description = "YAML 1.2 implementation for Nim"
|
description = "YAML 1.2 implementation for Nim"
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
|
|
||||||
# Dependencies
|
# Dependencies
|
||||||
|
|
||||||
requires "nim >= 0.13.1"
|
requires "nim >= 0.14.0"
|
||||||
|
|
Loading…
Reference in New Issue