diff --git a/readme.txt b/readme.md similarity index 67% rename from readme.txt rename to readme.md index 69e420a..75e9e71 100644 --- a/readme.txt +++ b/readme.md @@ -1,13 +1,18 @@ +# node-iptables + This is a node.js module for controlling iptables. It's very basic just for what we need at http://browserling.com. -It was written by Peteris Krumins (peter@catonmat.net, @pkrumins on twitter). -His blog is at http://www.catonmat.net -- good coders code, great reuse. +It was written by **Peteris Krumins** (peter@catonmat.net, @pkrumins on twitter). +His blog is at http://www.catonmat.net -- good coders code, great reuse. + +--- ------------------------------------------------------------------------------- +## Overview Here is an example usage: +``` var iptables = require('iptables'); iptables.allow({ @@ -22,18 +27,17 @@ Here is an example usage: dport : 34567, sudo : true }); +``` This allows connections to port 34567 from 10.1.1.5 and drops connections from the same port from everyone else. ------------------------------------------------------------------------------- +--- Ps. I once wrote an article on iptables on my blog, check it out: http://www.catonmat.net/blog/traffic-accounting-with-iptables - Sincerely, Peteris Krumins (twitter: @pkrumins) http://www.catonmat.net -