Index: packages/yaml/README.md |
diff --git a/packages/yaml/README.md b/packages/yaml/README.md |
new file mode 100644 |
index 0000000000000000000000000000000000000000..c78dc97d7f5aa0b2fa1abfa3805a9677e6be08b6 |
--- /dev/null |
+++ b/packages/yaml/README.md |
@@ -0,0 +1,26 @@ |
+A parser for [YAML](http://www.yaml.org/). |
+ |
+Use `loadYaml` to load a single document, or `loadYamlStream` to load a |
+stream of documents. For example: |
+ |
+```dart |
+import 'package:yaml/yaml.dart'; |
+ |
+main() { |
+ var doc = loadYaml("YAML: YAML Ain't Markup Language"); |
+ print(doc['YAML']); |
+} |
+``` |
+ |
+This library currently doesn't support dumping to YAML. You should use |
+`JSON.encode` from `dart:convert` instead: |
+ |
+```dart |
+import 'dart:convert'; |
+import 'package:yaml/yaml.dart'; |
+ |
+main() { |
+ var doc = loadYaml("YAML: YAML Ain't Markup Language"); |
+ print(JSON.encode(doc)); |
+} |
+``` |