Skip to content
This repository was archived by the owner on Dec 18, 2022. It is now read-only.

Commit b5b2ca7

Browse files
committed
add images of the sample app to docs
1 parent f24aaf5 commit b5b2ca7

4 files changed

Lines changed: 17 additions & 6 deletions

File tree

373 KB
Loading
941 KB
Loading
904 KB
Loading

docs/index.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,25 @@
11
# TorOnionProxyLibrary-Android
2-
An Android Library for embedding Tor as a service into your Application
2+
An Android Library for embedding Tor as a service into your Application
33

44
**NOTE: This project exists independently of the Tor Project, & Guardian Project.**
55

6-
This is a Fork of the <a href="https://github.com/thaliproject/Tor_Onion_Proxy_Library" target="_blank">Tor_Onion_Proxy_Library</a>
6+
This is a Fork of the
7+
<a href="https://github.com/thaliproject/Tor_Onion_Proxy_Library" target="_blank">Tor_Onion_Proxy_Library</a>
8+
project.
79

8-
This fork has been re-built from the ground up and engineered specifically for Android, where
9-
it was once multi-platform. It's been re-written in Kotlin, heavily refactored, and a separate
10-
`Service` created for abstracting away the complexities into simple APIs to make embedding Tor
11-
directly into your Application, easy.
10+
<center>
11+
<img src="assets/Screenshot_SampleApp_Debug_full.png" width="250"/>
12+
<img src="assets/Screenshot_SampleApp_Debug_notification1.png" width="250"/>
13+
<img src="assets/Screenshot_SampleApp_Debug_notification2.png" width="250"/>
14+
</center>
15+
16+
It's been re-built from the ground up and engineered specifically for :material-heart-multiple:
17+
Android :material-heart-multiple:, where it was once multi-platform. It's been re-written in
18+
Kotlin, heavily refactored to improve reliability/ease of use, and an `android.app.Service`
19+
built on top as an additional module/Library for abstracting away complexities.
20+
21+
The `topl-service` module/Library has simple to use APIs for integrating Tor into your
22+
application, and customizing the notification to meet your liking.
1223

1324
## [Project Roadmap](roadmap.md)
1425

0 commit comments

Comments
 (0)