Benjamin Conlan avatar Benjamin Conlan committed 159ac99

fixed package json

Comments (0)

Files changed (2)

 # JVMPin
 
-JVMPin provides a nodejs protocol implementation of the nailgun protocol
-for communication to nail gun hosted java applications.
+JVMPin provides a nodejs implementation of the nailgun protocol
+providing communication to nailgun hosted java applications.
 
 Information about nailgun can be found at
 http://www.martiansoftware.com/nailgun/. While the nailgun native
 
 ```
 
+You will need to start your nailgun instance in another process (this is
+a task I leave to the reader.
+
+Then simple connect to the nailgun instance using:
+```javascript
+
+var jvmpin = require('jvmpin');
+
+jvmpin.createConnection(1234, 'localhost').spawn('your.main.Class');
+
+```
+
+This will bind the STDIO streams to the executing process. (something
+that is yet to be corrected).
+
+For more information please consult the [API
+Documentation](https://bitbucket.org/foldr/jvmpin/raw/master/lib/jvmpin.js)
+
 ## License
 
 Copyright © 2012 Foldr 
 	"description": "Nailgun protocol implementation for node communction to jvm instance",
 	"version": "1.0.0",
 	"bugs": {
-		"url": "https://bitbucket.org/foldr/jvmpin/issues",
+		"url": "https://bitbucket.org/foldr/jvmpin/issues"
 	},
 	"repositories": {
 		"type": "git",
 		"url": "https://bitbucket.org/foldr/foldr.jvmpin.git"
 	},
-	"license": {
+	"licenses": [{
 		"type": "EPL",
-		"http://opensource.org/licenses/EPL-1.0"
-	},
+		"url": "http://opensource.org/licenses/EPL-1.0"
+	}],
 	"engines": {
 		"node": "~0.8"
 	},
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.