From 73c805a6810a6d57c353e312bfb586fc0410bbc8 Mon Sep 17 00:00:00 2001 From: Jonathan Wilkins Date: Mon, 5 May 2014 17:14:24 -0700 Subject: [PATCH] README verbiage from subgraph.com/orchid.html --- README | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README b/README index e69de29b..3d486477 100644 --- a/README +++ b/README @@ -0,0 +1,22 @@ +Orchid is a Tor client implementation and library written in pure Java. + +It was written from the Tor specification documents, which are available at https://www.torproject.org/docs/documentation.html.en + +Orchid runs on Java 5+ and Android devices. + +Version 1.0 was released on November 27, 2013 and announced at the Minga por la Libertad Tecnologica (https://minga.asle.ec/). + +HOW CAN ORCHID BE USED? +In a basic use case, running Orchid will open a SOCKS5 listener which can be used as a standalone client where Tor would otherwise be used. + +Orchid can also be used as a library by any application running on the JVM. This is what Orchid was really designed for and this is the recommended way to use it. Orchid can be used as a library in any Java application, or any application written in a language that compiles bytecode that will run on the Java virtual machine, e.g., JRuby, Clojure, Scala.. + +WHY WAS ORCHID DEVELOPED? +Orchid was developed for seamless integration of Tor into Java applications. The first application to have built-in Tor support is Martus (https://www.martus.org/), a human rights application developed by Benetech (http://www.benetech.org/). + +Another reason Orchid was developed was to work through and debug the Tor specification documents. Orchid was also created to provide a reference implementation in Java. This may be easier to understand for those who are unfamiliar with the C programming language. The implementation is also simpler because only the client has been implemented. + +SHOULD ORCHID BE USED WITH A REGULAR BROWSER FOR ANONYMOUS BROWSING? +Probably not. We recommend that the Tor Browser Bundle (or better yet, Tails) be used, as there are privacy leaks through the browser that are unrelated to Tor. However, Orchid can be used with the Tor Browser bundle in the place of native Tor. + +Orchid's strength is that it can be used to Torify Java and JVM applications with near transparency.