Permalink
Browse files

Convert README to markdown.

  • Loading branch information...
1 parent 1c76dd0 commit f73319b373c8c33c1e11d5cb0b844db9c5084cf6 Tobie Langel committed Aug 9, 2011
Showing with 13 additions and 10 deletions.
  1. +13 −10 README.markdown
View
23 README.markdown
@@ -1,12 +1,12 @@
-================================================================================
- YAML Parser for Javascript
---------------------------------------------------------------------------------
+YAML Parser for Javascript
+==========================
+
+Author: Diogo Costa (<costa.h4evr@gmail.com>)
-Author: Diogo Costa (costa.h4evr@gmail.com)
Date: 8th August 2011
-================================================================================
-DESCRIPTION
+Description
+-----------
This is CommonJS port of my Javascript YAML Parser, available at:
http://code.google.com/p/javascript-yaml-parser/
@@ -16,19 +16,22 @@ parser. It does not intend to implement all the aspects formalized in the YAML
specs, but rather to implement a robust parser in Javascript, enough to load
simply structured YAML files.
-INSTALLATION
+Installation
+------------
The parser is available as a NPM module, this is the recommended way of installation.
Run the following command and you should be ready to go:
- npm install yamlparser -g
+ npm install yamlparser
-DOCUMENTATION
+Documentation
+-------------
ToDo
-DISCLAIMER
+Disclaimer
+----------
I try to deliver high quality products, but I do not guarantee that the product
is free from defects. My software is provided "as is", and you use the software

0 comments on commit f73319b

Please sign in to comment.