Index: pkg/yaml/lib/yaml.dart |
diff --git a/pkg/yaml/lib/yaml.dart b/pkg/yaml/lib/yaml.dart |
index 94e3d4220f48c4ad3b0dff931a8029d116420770..85861d564324f7762f2b34c9048029de4c135648 100644 |
--- a/pkg/yaml/lib/yaml.dart |
+++ b/pkg/yaml/lib/yaml.dart |
@@ -4,6 +4,21 @@ |
/// A parser for [YAML](http://www.yaml.org/). |
/// |
+/// ## Installing ## |
+/// |
+/// Use [pub][] to install this package. Add the following to your |
+/// `pubspec.yaml` file. |
+/// |
+/// dependencies: |
+/// yaml: any |
+/// |
+/// Then run `pub install`. |
+/// |
+/// For more information, see the |
+/// [yaml package on pub.dartlang.org][pkg]. |
+/// |
+/// ## Using ## |
+/// |
/// Use [loadYaml] to load a single document, or [loadYamlStream] to load a |
/// stream of documents. For example: |
/// |
@@ -22,6 +37,9 @@ |
/// var doc = loadYaml("YAML: YAML Ain't Markup Language"); |
/// print(json.stringify(doc)); |
/// } |
+/// |
+/// [pub]: http://pub.dartlang.org |
+/// [pkg]: http://pub.dartlang.org/packages/yaml |
library yaml; |
import 'src/composer.dart'; |