Skip to content

Commit

Permalink
Packages up port scanner for NPM.
Browse files Browse the repository at this point in the history
  • Loading branch information
baalexander committed Aug 29, 2011
1 parent 8c1f11e commit 5cca315
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

## The What

The portscanner module is a pure JavaScript port scanner for node.js.
The portscanner module is an asynchronous JavaScript port scanner for Node.js.

Portscanner can check a port, or range of ports, for 'open' or 'closed'
statuses.
Expand All @@ -10,8 +10,9 @@ statuses.

### To Install

NPM package coming soon. Needs more testing and features first. For now, require
the lib/portscanner.js file.
```bash
npm install portscanner
```

### To Use

Expand Down Expand Up @@ -39,13 +40,18 @@ portscanner.findAClosedPort(3000, 3010, 'localhost', function(error, port) {
})
```

Also check the example directory for more examples.
The example directory contains a more detailed example.

### To Test

Bleh. I am a fan of testing, but currently looking into an easier way to test
HTTP connections. If any ideas, please message me.

## The Future

Please create issues, or better yet, pull requests, for port scanning related
features you'd like to see included.

## The License (MIT)

Released under the MIT license. See the LICENSE file for the complete wording.
Expand Down
24 changes: 24 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
{ "name" : "portscanner"
, "description" : "Asynchronous port scanner for Node.js"
, "keywords" : [ "portscanner", "port", "scanner", "checker", "status" ]
, "version" : "0.1.0"
, "preferGlobal" : false
, "homepage" : "https://github.com/baalexander/node-portscanner"
, "author" : "Brandon Alexander <[email protected]> (https://github.com/baalexander)"
, "repository" :
{ "type" : "git"
, "url" : "git://github.com/baalexander/node-portscanner.git"
}
, "bugs" : { "web" : "https://github.com/baalexander/node-portscanner/issues" }
, "directories" : { "lib" : "./lib" }
, "main" : "./lib/portscanner.js"
, "dependencies" : { }
, "devDependencies" : { }
, "engines" : { "node" : ">=0.4", "npm" : ">=1.0.0" }
, "licenses" :
[ { "type" : "MIT"
, "url" : "https://github.com/baalexander/node-portscanner/raw/master/LICENSE"
}
]
}

0 comments on commit 5cca315

Please sign in to comment.