Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ionous committed Jan 17, 2024
1 parent 7b4b2e1 commit e39ee34
Showing 1 changed file with 23 additions and 10 deletions.
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,7 @@ It isn't intended to be a subset of yaml, but it tries to be close enough to lev
Status
----
Version 0.7
The go implementation successfully reads and writes some well-formed documents.
The go implementation successfully reads and writes well-formed documents.
[![PkgGoDev](https://pkg.go.dev/badge/github.com/ionous/tell)](https://pkg.go.dev/github.com/ionous/tell)
![Go](https://github.com/ionous/tell/workflows/Go/badge.svg)
Expand All @@ -54,7 +52,7 @@ The go implementation successfully reads and writes some well-formed documents.
* serialization of structs not supported ( only maps, slices, and primitive values. )
* arrays should (probably) support nested arrays;
* arrays should (probably) support comments.
* error reporting needs improvement.
* error reporting could use improvement.
see also the [issues page](https://github.com/ionous/tell/issues).
Expand Down Expand Up @@ -265,18 +263,33 @@ Changes
-----

0.3 -> 0.4:
- adopt the golang (package stringconv) rules for escaping strings.
- adopt the golang (package stringconv) rules for escaping strings.
- simplify the attribution of comments in the space between a key (or dash) and its value.
- change the decoder api to support custom sequences, mirroring custom maps; package 'maps' is now more generically package 'collect'.
- encoding/decoding heredocs for multiline strings
- encoding/decoding of arrays; ( encoding will write empty collections as arrays; future: a heuristic to determine what should be encoded as an array, vs. sequence. )
- the original idea for arrays was to use a bare comma full-stop format. switched to square brackets because they are easier to decode, they can support nesting, and are going to be more familiar to most users. ( plus, full stop (.) is tiny and easy to miss when looking at documents. )

0.4 -> 0.5:
- simplify comment handling
- simplify comment handling
0.5 -> 0.6:
- bug fixes, and re-encoding of comments

0.6 -> 0.7
- replace comment raw string buffer usage with an opaque object ( to make any future changes more friendly )
- bug fixes, and re-encoding of comments

0.6 -> 0.7:
- replace comment raw string buffer usage with an opaque object ( to make any future changes more friendly )
0.7 -> 0.8:
- Changes the encoder's interface to support customizing the comment style of mappings and sequences independently.
- bug fix: when specifying map values: allow sequences to start at the same indentation as the key and allow a new map term to start after the sequence ends. ( previously, it generated an error, and an additional indentation was required. ) For example:
```yaml
- First: # the value of First is a sequence containing "yes"
- "yes"
Second: # Second is an additional entry in the same map as First
- "okay"
```
- bug fix: for all other values, an indentation greater than the key is required. For example:
```yaml
First:
"this is an error."
```

0 comments on commit e39ee34

Please sign in to comment.