summaryrefslogtreecommitdiff
path: root/std/encoding/README.md
diff options
context:
space:
mode:
authorLilian Saget-Lethias <lilian.sagetlethias@gmail.com>2019-11-18 15:39:32 +0100
committerRy Dahl <ry@tinyclouds.org>2019-11-18 09:39:32 -0500
commit5671d38d8f0176c2828a242a79a856fcfae93c3e (patch)
tree54e059f109baae9b3ff9161847149ecdac753e50 /std/encoding/README.md
parenta2f5bccad7f73607dc4ec20bdb60c6c4ac8dc9e6 (diff)
feat: Add std/encoding/yaml module (#3361)
Diffstat (limited to 'std/encoding/README.md')
-rw-r--r--std/encoding/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/std/encoding/README.md b/std/encoding/README.md
index 2b209c6b6..dbb9f4191 100644
--- a/std/encoding/README.md
+++ b/std/encoding/README.md
@@ -219,3 +219,24 @@ const obj = {
};
const tomlString = stringify(obj);
```
+
+## YAML
+
+YAML parser / dumper for Deno
+
+Heavily inspired from [js-yaml]
+
+### Example
+
+See [`./yaml/example`](./yaml/example) folder and [js-yaml] repository.
+
+### :warning: Limitations
+
+- `binary` type is currently not stable
+- `function`, `regexp`, and `undefined` type are currently not supported
+
+# Basic usage
+
+TBD
+
+[js-yaml]: https://github.com/nodeca/js-yaml