aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Odersky <jakob@odersky.com>2018-04-08 20:30:44 -0700
committerJakob Odersky <jakob@odersky.com>2018-04-08 20:32:20 -0700
commitda6a5cad7ef0fe723ac126f921f97c36962f42af (patch)
treed86aae792a7c96c22685ba1657abc766d56d4be0 /README.md
parent98f1acf269312545192be115c75a6cce58c00766 (diff)
downloadyamlesque-da6a5cad7ef0fe723ac126f921f97c36962f42af.tar.gz
yamlesque-da6a5cad7ef0fe723ac126f921f97c36962f42af.tar.bz2
yamlesque-da6a5cad7ef0fe723ac126f921f97c36962f42af.zip
Restructure build
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 24 insertions, 8 deletions
diff --git a/README.md b/README.md
index ba3f9aa..34544dd 100644
--- a/README.md
+++ b/README.md
@@ -4,13 +4,8 @@ Pure Scala YAML parsing.
As the name suggests, "yam-el-esque" is a Scala implementation of the
most frequently used YAML features. It takes inspiration from
-Spray-JSON and aims to provide an idiomatic, to-the-point API that is
-cross-platform and has a minimal set of dependencies.
-
-It does not strictly implement all features as defined in [YAML
-1.2](http://yaml.org/spec/1.2/spec.html), however support should be
-sufficient for regular use. Pull requests with additional feature
-implementations are always welcome!
+Spray-JSON and aims to provide an idiomatic API that is cross-platform
+and has a minimal set of dependencies.
## Getting Started
Include yamlesque into a project. In sbt, this can be done with:
@@ -31,6 +26,27 @@ val text = s"""|name: yamlesque
| - name: Another
|""".stripMargin
-// parse yaml to a typesafe representation
+// parse yaml to a type safe representation
val yaml = text.parseYaml
```
+
+### Integration with Spray-JSON
+*TODO*
+
+### Integration with Akka-HTTP
+*TODO*
+
+## YAML Conformance
+
+Yamlesque does not strictly implement all features as defined in [YAML
+1.2](http://yaml.org/spec/1.2/spec.html), however support should be
+sufficient for most regular documents. Pull requests with additional
+feature implementations are always welcome!
+
+The current feature restrictions are:
+
+- always assumes utf-8 is used
+- anchors and references are not supported
+- tags are not supported
+- flow-styles (aka inline JSON) aren't supported
+- only single-line literals are allowed (no > or | blocks)