Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Cleaning up README file and package.json #1

Merged
merged 3 commits into from

2 participants

@tobie

A couple of changes which would make usage a lot easier (and not unnecessarily tie your package to a specific version of node, or to node at all).

Tobie Langel added some commits
@h4evr h4evr merged commit 3e4ad4c into from
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Aug 9, 2011
  1. Rename README.

    Tobie Langel authored
  2. Convert README to markdown.

    Tobie Langel authored
  3. No need to restrict package to node.

    Tobie Langel authored
This page is out of date. Refresh to see the latest.
Showing with 15 additions and 17 deletions.
  1. +13 −10 README → README.markdown
  2. +2 −7 package.json
View
23 README → 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
View
9 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"
}
Something went wrong with that request. Please try again.