Skip to content

Commit 070830e

Browse files
authoredJun 30, 2020
Expand the README now that we're live
1 parent e2bbe33 commit 070830e

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed
 

‎README.md

+19-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
# httptoolkit-android
22

3-
Automatic interception of Android HTTP with [HTTP Toolkit](https://httptoolkit.tech), for inspection, debugging & mocking.
3+
Automatic interception of Android HTTP with [HTTP Toolkit](https://httptoolkit.tech/android), for inspection, debugging & mocking.
44

5-
Still in alpha. See https://httptoolkit.tech/docs/guides/android/ for the usage docs.
5+
Looking to file bugs, request features or send feedback? File an issue or vote on existing ones at [github.com/httptoolkit/feedback](https://github.com/httptoolkit/feedback).
6+
7+
## What is this?
8+
9+
HTTP Toolkit is primarily a desktop application. This repo contains the Android app, which connects to that desktop application, and forwards HTTP traffic there.
10+
11+
The Android itself is effectively two parts:
12+
13+
* An outer wrapper, which shows the UI, scans QR codes, retrieves proxy config from HTTP Toolkit, ensures the device trusts HTTP Toolkit's CA certificate, and starts and stops a VPN.
14+
* A VPN, which receives every IP packet sent by the device, parses them, rewrites some of them to go to HTTP Toolkit, and then sends the parsed requests on via the real network (and forwards responses back)
15+
16+
## Contributing
17+
18+
If you're looking to contribute to the Android app itself, you're in the right place. If you're looking to explore or change how the ADB-based Android setup works, you want to take a look at [HTTP Toolkit server](https://github.com/httptoolkit/httptoolkit-server) instead.
19+
20+
You can build and test this Android app in Android studio, like any other. It's half in Kotlin (the outer wrapper) and half in Java (most of the VPN code).
21+
22+
To test the app you can either set up the other components of HTTP Toolkit for development on your machine, or use it with any standard install of HTTP Toolkit. A rooted device isn't required for testing, but you will find that it helps, as you can test with a wider variety of real app traffic.

0 commit comments

Comments
 (0)
Please sign in to comment.