Skip to content

Commit

Permalink
Updates to all documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanbillingsley committed Feb 5, 2014
1 parent 250604a commit 207ac56
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 7 deletions.
22 changes: 22 additions & 0 deletions LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
(The MIT License)

Copyright (c) 2012 Dwolla <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ IP Filter: A light-weight IP address based filtering system

This package provides easy IP based access control. This can be achieved either by blacklisting certain IPs and whitelisting all others, or whitelisting certain IPs and blacklisting all others.

[![Build Status](https://secure.travis-ci.org/Dwolla/node-ipfilter.png?branch=master)](http://travis-ci.org/Dwolla/node-ipfilter)
[![Build Status](https://secure.travis-ci.org/baminteractive/node-ipfilter.png?branch=master)](http://travis-ci.org/baminteractive/node-ipfilter)

## Version
0.0.4
0.0.5

## Requirements
- [Node](http://github.com/ry/node)
Expand Down Expand Up @@ -53,8 +53,30 @@ app.use(ipfilter(ips, {mode: 'allow'}));
app.listen(3000);
```

Using CIDR subnet masks for ranges:

```javascript
// Init dependencies
var express = require('express')
, ipfilter = require('ipfilter')
, app = express.createServer()
;

// Blacklist the following IPs
var ips = ['127.0.0.1/24'];

// Create the server
app.use(ipfilter(ips, {mode: 'allow'}));
app.listen(3000);
```

## Changelog

0.0.5

* Added ability to block by subnet mask (i.e. 127.0.0.1/24)
* Added tests for cidr functionality

0.0.4

* Add tests
Expand All @@ -67,7 +89,7 @@ app.listen(3000);

## Credits

Michael Schonfeld <[email protected]>
BaM Interactive

## License

Expand Down
6 changes: 6 additions & 0 deletions humans.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/* TEAM */
Ryan Billingsley
Your title: Senior Interactive Developer
Site: code.bamideas.com
Twitter: interactivebam
Location: Indianapolis, IN, USA.
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "ipfilter",
"description": "A light-weight IP address based filtering system",
"version": "0.0.4",
"author": "Michael Schonfeld <michael@dwolla.com>",
"version": "0.0.5",
"author": "BaM Interactive <interactive@bamideas.com>",
"dependencies": {
"underscore": "1.3.3",
"netmask": "~1.0.4",
Expand All @@ -20,11 +20,11 @@
],
"repository": {
"type": "git",
"url": "http://github.com/dwolla/node-ipfilter.git"
"url": "http://github.com/baminteractive/node-ipfilter.git"
},
"main": "index.js",
"scripts": {
"test": "mocha -R spec"
},
"license": "BSD"
"license": "MIT"
}

0 comments on commit 207ac56

Please sign in to comment.