Updated README
diff --git a/pkgs/markdown/README.md b/pkgs/markdown/README.md index 04ffb5c..36dd256 100644 --- a/pkgs/markdown/README.md +++ b/pkgs/markdown/README.md
@@ -1,4 +1,31 @@ -dart-markdown -============= +dartdoc markdown library +======================== -A standalone version of the dartdoc markdown library. \ No newline at end of file +This is a standalone version of the [dartdoc][dartdoc] markdown library. It +parses markdown and converts it to HTML. + +Installation +------------ + +Add this to your `pubspec.yaml` (or create it): +```yaml +dependencies: + markdown: any +``` +Then run the [Pub Package Manager][pub] (comes with the Dart SDK): + + pub install + +Usage +----- + +```dart +import "package:markdown/markdown.dart" show markdownToHtml; + +main() { + print(markdownToHtml("Hello *Markdown*")); +} +``` + +[dartdoc]: https://github.com/d2m/dartdoc +[pub]: http://www.dartlang.org/docs/pub-package-manager/
diff --git a/pkgs/markdown/pubspec.yaml b/pkgs/markdown/pubspec.yaml index 1781d4a..680dc84 100644 --- a/pkgs/markdown/pubspec.yaml +++ b/pkgs/markdown/pubspec.yaml
@@ -1,7 +1,7 @@ name: markdown -author: "Dart Team <misc@dartlang.org>" -homepage: https://github.com/dpeek/dart-markdown +version: 0.4.0 +author: Dart Team <misc@dartlang.org> description: A library for converting markdown to HTML. -version: 0.3.4 +homepage: https://github.com/dpeek/dart-markdown dependencies: - unittest: any \ No newline at end of file + unittest: any