protagonist - npm Package Compare versions

Comparing version 0.0.11 to 0.1.0

package.json

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

README.md

@@ -11,3 +11,5 @@ # Protagonist [![Build Status](https://travis-ci.org/apiaryio/protagonist.png?branch=master)](https://travis-ci.org/apiaryio/protagonist)
 
-	$ npm install protagonist
+```sh
+$ npm install protagonist
+```
 
@@ -29,3 +31,3 @@ ## Getting started
 
-## Hacking
+## Hacking Protagonist
 You are welcome to contribute. Use following steps to build & test Protagonist.
@@ -38,23 +40,35 @@
 
-		$ npm install -g node-gyp
+	```sh
+	$ npm install -g node-gyp
+	```
 
-
 2. Clone the repo + fetch the submodules:
 
-		$ git clone git://github.com/apiaryio/protagonist.git
-		$ cd protagonist
-		$ git submodule update --init --recursive
+	```sh
+	$ git clone git://github.com/apiaryio/protagonist.git
+	$ cd protagonist
+	$ git submodule update --init --recursive
+	```
     
 3. Build:
+	
+	```sh
+	$ node-gyp configure
+	$ node-gyp build	
+	```
 
-	    $ node-gyp configure
-    	$ node-gyp build
-
 ### Test
-Inside protagonist repository run:
+Inside the protagonist repository run:
 
-	$ npm install
-	$ npm test
+```sh
+$ npm install
+$ npm test
+```
+	
+### Contribute
+Fork & Pull Request. 
 
+Make sure to follow the [API Blueprint Developers discussion group](https://groups.google.com/forum/#!forum/apiblueprint-dev). Also check the Protagonist [issues page](https://github.com/apiaryio/protagonist/issues?state=open).
+
 ## License
 MIT License. See the [LICENSE](https://github.com/apiaryio/protagonist/blob/master/LICENSE) file.

snowcrash/README.md

 # Snow Crash [![Build Status](https://travis-ci.org/apiaryio/snowcrash.png?branch=master)](https://travis-ci.org/apiaryio/snowcrash)
 
 ### API Blueprint Parser
-
 Snow Crash is the reference [API Blueprint](http://apiblueprint.org) parser built on top of the [Sundown](https://github.com/vmg/sundown) Markdown parser.
@@ -15,39 +14,46 @@
 
-* [Protagonist](https://github.com/apiaryio/protagonist) (Node.js)
+- [Protagonist](https://github.com/apiaryio/protagonist) (Node.js)
+- [snowcrashCLR](https://github.com/SeriousM/snowcrashCLR) (.NET)
 
 ## Build
-Snow Crash uses [Gyp](http://code.google.com/p/gyp/) build automation tool to generates its Makefiles.
+1. Clone the repo + fetch the submodules:
 
-1. If needed, install Gyp. Either from its package:
-	
-		$ sudo apt-get install gyp
+	```sh
+	$ git clone git://github.com/apiaryio/snowcrash.git
+	$ cd snowcrash
+	$ git submodule update --init --recursive
+	```
 
-	or from source:
+2. Build & test Snow Crash:
 
-		$ svn checkout http://gyp.googlecode.com/svn/trunk/ gyp
-		$ cd ./gyp
-		$ sudo python setup.py install	
+	```sh
+	$ ./configure
+	$ make test
+	```
+	
+We love **Windows** too! Please refer to [Building on Windows](https://github.com/apiaryio/snowcrash/wiki/Building-on-Windows).
 		
-	See [Gyp Hello World](https://github.com/springmeyer/hello-gyp) for a primer on installing and using Gyp.
+### Snow Crash command line tool
+
+1. Build `snowcrash`:
 	
-2. Clone the repo + fetch the submodules:
+	```sh
+	$ make snowcrash
+	```
 
-		$ git clone git://github.com/apiaryio/snowcrash.git
-		$ cd snowcrash
-		$ git submodule update --init --recursive
+2. Install & use `snowcrash`:
 
-3. Build & test Snow Crash:
+	```sh
+	$ sudo make install
+	$ snowcrash --help
+	```
 
-		$ ./configure
-		$ make test
+## Contribute
+Fork & Pull Request. 
 
-		
-### Build `snowcrash` command line tool
-	
-To build & run Snow Crash command line tool use:
+Make sure to follow the [API Blueprint Developers discussion group](https://groups.google.com/forum/#!forum/apiblueprint-dev). Also check the Snow Crash [issues page](https://github.com/apiaryio/snowcrash/issues?state=open).
 
-	$ make snowcrash
-	$ ./bin/snowcrash
+If you want to create a binding for Snow Crash please refer to the [Writing a binding](https://github.com/apiaryio/snowcrash/wiki/Writing-a-binding) Wiki article.
 
 ## License
 MIT License. See the [LICENSE](https://github.com/apiaryio/snowcrash/blob/master/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

Mixed license

License

(Experimental) Package contains multiple licenses.

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

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3295642

increased by117.5%

Number of package files

347

increased by30.94%

Number of lines in readme file

72

increased by24.14%

No dependency changes