status-im
/
NimYAML
mirror of https://github.com/status-im/NimYAML.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

README update 

* project status
 * deleted transient fields from future feature list because it's implemented
This commit is contained in:
flyx 2018-08-30 09:49:02 +02:00 committed by GitHub
parent ba53fc0494
commit 6ca2a8e98a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -12,15 +12,19 @@ Documentation, examples and an online demo are available [here][1]. Releases are
available as tags in this repository and can be fetched via nimble: available as tags in this repository and can be fetched via nimble:
nimble install yaml nimble install yaml
## Status
## Features that may come in the future The library is fairly stable, I only maintain it and will not add any features due to lack of time and interest. There are few issues with YAML corner cases in the lexer which you are unlikely to encounter unless you're going for them. Fixing them would mean a larger refactor of the lexer which I am not willing to do.
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.
## Features that have been planned, but will not be implemented by myself
* Serialization: * Serialization:
- Support for more standard library types - Support for more standard library types
- Support for polymorphism - Support for polymorphism
- Support for generic objects - Support for generic objects
- Support for transient fields (i.e. object fields that will not be
(de-)serialized
## Developers ## Developers