From c279d66fc9e69d8a7d9b910c7d47128cb6dcc873 Mon Sep 17 00:00:00 2001 From: akwizgran <michael@briarproject.org> Date: Wed, 29 Mar 2023 10:08:08 +0100 Subject: [PATCH] Add README. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..086cd05 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +## Onion Wrapper + +A Java library providing a wrapper for running a Tor client on Android, Unix and Windows. The +wrapper can be used for running hidden services. + +The library supports the `obfs4`, `meek_lite` and `snowflake` pluggable transports. + +Binaries for Tor and pluggable transports are not included. They can be found in the following +Maven artifacts: `org.briarproject:{tor,obfs4proxy,snowflake}-{android,linux,windows}`. The +`obfs4proxy` artifact provides `obfs4` and `meek_lite`. + +On Android, the library uses +[dont-kill-me-lib](https://code.briarproject.org/briar/dont-kill-me-lib) to hold a wake lock +whenever Tor's network connection is enabled. The helper classes in `dont-kill-me-lib` can be used +to work around certain manufacturer-specific power management restrictions that would prevent Tor +from running in the background for long periods. -- GitLab