diff --git a/README b/README deleted file mode 100644 index e69de29b..00000000 diff --git a/README.md b/README.md new file mode 100644 index 00000000..660c1d08 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +Orchid +====== + +The Orchid TOR library is a pure Java implementation of the TOR protocol. The library also +provides a built-in TOR-enabled proxy server. The remainder of this file describes using the +library - see the javadocs for details on integrating it with your Java program. + +Usage +----- + +Starting Orchid is pretty easy. Using Java 1.5 or greater, simply point your browser (or +other HTTP client) to localhost:9150. If you also want the dashboard to be exposed, launch +Orchid using the following command: + + java -Dcom.subgraph.orchid.dashboard.port=10000 -jar orchid-1.0.0.jar + +Dashboard +--------- + +Viewing the dashboard can be accomplished with any "TCP listener". From the CLI, the easiest +way to watch the dashboard is to use NetCat as follows: + + netcat localhost 10000 + +Note that on some systems, netcat is delivered with the name "nc" so the above command would +be changed as follows: + + nc localhost 10000