From 9bdde7fa48113feeb148c81209b483ea432f7c4c Mon Sep 17 00:00:00 2001 From: migueldar Date: Thu, 22 Jun 2023 11:11:44 +0200 Subject: [PATCH] improved README --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2a97747..44149d4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -To start, run `npm install` and `npx zx start.mjs up` +# RENTGEN ANDROID +The aim of this project is to be able to visualize all the data that a given android app ~~steals~~ sends to third parties. -And then, to check the proxy logs you can do `docker exec -it proxy tail -f /log` -and to go into the android `docker exec -it android bash` +We are currently in v1, the environment, which is made up of a mitmproxy machine and an ubuntu machine with android emulator was created using docker, in future versions the [rentgen](https://github.com/internet-czas-dzialac/rentgen) firefox extension will be adapted to interpret the traffic from the proxy and display it in a user-friendly way + +To get started, run `npm install` and `npx zx start.mjs up` +And then, to check the proxy's logs you can do `docker exec -it proxy tail -f /log` and to go into the android `docker exec -it android bash` \ No newline at end of file