protagonist - npm Package Compare versions

Comparing version 0.0.1 to 0.0.3

package.json

 {
   "name": "protagonist",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "API Blueprint Parser",
@@ -5,0 +5,0 @@ "author": "Apiary.io <[e-mail]>",

README.md

@@ -1,18 +0,54 @@
-protagonist
-===========
+# Protagonist
+### API Blueprint Parser for Node.js
 
-Protagonist is Node.js wrapper for the Snowcrash library.
+Protagonist is a Node.js wrapper for the [Snow Crash](https://github.com/apiaryio/snowcrash) library.
 
-**This is work in progress. Everything will be chnaged** 
+Full API Blueprint documentation can be found on the [API Blueprint site](http://apiblueprint.org).
 
+## Install
+The best way to install Protagonist is by using its [NPM package](https://npmjs.org/package/protagonist).
 
-Build with: 
+	$ npm install protagonist
+
+## Getting started
+
+	```js
+	var protagonist = require('protagonist');
+	var blueprint = "# My API"
+	protagonist.parse(blueprint, function(error, ast) {
+		if (error) {
+    		console.log(error);
+		    return;
+  		}
+  
+	  console.log(ast);
+	}
+	```
+
+## Hacking
+You are welcome to contribute. Use following steps to build & test Protagonist.
+
+### Build
+Protagonist uses [node-gyp](https://github.com/TooTallNate/node-gyp) build tool. 
+
+1. Clone the repo + fetch the submodules:
+
+		$ git clone git://github.com/apiaryio/protagonist.git
+		$ cd protagonist
+		$ git submodule update --init --recursive
+
+2. If needed, install node-gyp:
+
+		$ npm install -g node-gyp
     
-    $ node-gyp configure
-    $ node-gyp build
+3. Build:
 
-Run:
+	    $ node-gyp configure
+    	$ node-gyp build
 
-    $ node test/test.js
+### Test
 
+	$ TODO
 
+## License
+See LICENSE file.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1236931

increased by0.15%

Number of package files

240

increased by0.42%

Number of lines in readme file

55

increased by189.47%

No dependency changes