diff --git a/README b/README.markdown similarity index 74% rename from README rename to README.markdown index d94fe2a..25bbefe 100644 --- a/README +++ b/README.markdown @@ -1,12 +1,12 @@ -================================================================================ - YAML Parser for Javascript --------------------------------------------------------------------------------- +YAML Parser for Javascript +========================== + +Author: Diogo Costa () -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 diff --git a/package.json b/package.json index 4a5e4cd..abf9006 100644 --- a/package.json +++ b/package.json @@ -4,13 +4,8 @@ "description": "A YAML parser written in javascript. This is the port to CommonJS. Client-side script is available at http://code.google.com/p/javascript-yaml-parser/", "version": "0.0.2", "repository": { - "type": "git", + "type": "git", "url": "git://github.com/h4evr/commonjs-javascript-yaml-parser.git" }, - "main": "yamlparser", - "engines": { - "node": "~v0.5.3" - }, - "dependencies": {}, - "devDependencies": {} + "main": "yamlparser" }