@@ -8,22 +8,22 @@ This is a Fork of the <a href="https://github.com/thaliproject/Tor_Onion_Proxy_L
88It's been rebuilt from the ground up and engineered specifically for Android, where it was
99once multiplatform. It's been re-written in Kotlin, refactored to solve its concurrency
1010issues (among many others), and documented (still a work in progress). There are still
11- many ` Exceptions ` that I'm sure have been missed being documented, but it's an ongoing
12- process to improve reliability.
11+ ` Exceptions ` that I'm sure I've missed annotating as there were little to none documented
12+ pre-refactor, but it's an ongoing process to improve reliability/usability .
1313
1414** What does it do?**
1515The ` topl-core ` module contains the guts of operations for setting up a file system
1616in your application's data directory which Tor needs to run. It is the medium for which
1717other libraries built atop it access the TorProcess. The ` topl-core-base ` module contains
1818the base classes needed so that a library user of the ` topl-service ` module (or any other
19- library built on top of ` topl-core ` ), doesn't rely directly on core and only needs to
20- import ` topl-core-base ` to set things up.
19+ library built on top of ` topl-core ` ), won't need to rely directly on core and only needs to
20+ import ` topl-core-base ` to get things set up.
2121
2222The ` topl-service ` module is built atop the core modules and provide a simple way to embed
2323Tor as a foreground service into your application. It abstracts the technical &
24- difficult to understand things from ` topl-core ` away, and boils things down into an easy
25- to implement/use Library. Documentation on this will be provided upon release (it's suuuuuuuper
26- simple and customizable to your liking ;-D!).
24+ difficult to understand things from ` topl-core ` away, and boils them down to an easy
25+ to implement/use Library. Documentation on this will be provided upon release (it's
26+ suuuuuuuper simple to implement and customizable to your liking ;-D!).
2727
2828** What's the current Progress?**
2929Tor is running very reliably. Start/stop works great on API 16-29 (Still needs much
@@ -35,18 +35,18 @@ play around with it.
3535 - Import dependenies into your Android App.
3636 - Extend the ` TorSettings ` class (used to build the ` torrc ` file) and configure it to your
3737 liking (I've made it as easy as I could to understand and provide default values to use. See
38- the ` SampleApp ` 's ` MyTorSettings ` class).
38+ the ` sampleapp: MyTorSettings ` class, or the documentation in the ` topl-core-base: TorSettings ` class).
3939 - Initialize things by implementing the ` TorServiceController.Builder ` in your
4040 ` Application ` class' ` onCreate ` and customize it as desired.
4141 - Call ` TorServiceController.startTor ` /` stopTor ` /` restartTor ` /` newIdentity `
4242 - That's it...
4343
4444** Plans for more**
45- - Enabling the passing of commands directly to the TorProcess which gives you full control
45+ - Enable the passing of commands directly to the TorProcess which gives you full control
4646 over it.
4747 - An ` onSharedPreferenceChangedListener ` so that when your users modify settings and you
48- save them to SharedPreferences via the ` TorServicePrefs ` class, those settings which don't
49- require a restart of the TorProcess will be applied automatically .
48+ save them to SharedPreferences via the ` topl-service: TorServicePrefs` class, those settings
49+ will be applied immediately (if not requiring a restart of Tor, ofc) .
5050 - Making Bridge support easier to use. Things are not yet hooked up for it in the ` topl-service `
5151 module, but are working in ` topl-core ` .
5252 - Access control for authenticating to v3 Hidden Services.
@@ -55,9 +55,9 @@ play around with it.
5555
5656 ** How do I play with it now?**
5757 - Clone the repo
58- - Initilize the get submodules
58+ - Initilize the git submodules
5959 - If you cannot run Bash scripts:
6060 - In the ` topl-core ` module's ` build.gradle ` file, comment out the ` gradle.projectsEvaluated `
6161 block located at the bottom of the file.
6262 - Import to AndroidStudio
63- - Run the ` SampleApp ` and look at Logcat.
63+ - Run the ` SampleApp ` and look at Logcat.
0 commit comments