Skip to content

Commit

Permalink
updated README.md. again.
Browse files Browse the repository at this point in the history
  • Loading branch information
itsnotlupus committed Jul 9, 2011
1 parent 8869d08 commit 302d717
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Expand Up @@ -3,14 +3,18 @@

Because you can never have too many namecoin socks proxies.

This one is written for node.js.
It implements some of the new spec.
It gets namecoin records from namecoind on demand, rather than doing bulk grabs and caching.
This one is written for node.js.
It implements some of the new namecoin spec ( http://dot-bit.org/Domain_names )
It gets namecoin records from namecoind on demand, rather than doing bulk grabs and caching.
It tries pretty hard to "just work", although it has command line switches to fine tune its behavior.

## dependencies:

- node ( http://nodejs.org/ )
- optimist and binary ( `npm install optimist binary `)
- namecoin ( https://github.com/vinced/namecoin )

`namecoind` will need to be running for this proxy to be useful.

## todo

Expand All @@ -25,9 +29,13 @@ From the parent directory,

node nmcsocks

There are a bunch of command line switches.
By default, nmcsocks will attempt to chain connections into another local socks proxy on port 9050.
If such a proxy doesn't exist, connections are made directly.

To run in strict "Tor" mode, where DNS leaks are prevented and "tor" fields in Namecoin records are given priority, use

node nmcsocks --tor

To see all the settings, try

node nmcsocks -h
Expand Down

0 comments on commit 302d717

Please sign in to comment.