From 37a2069be985b684ec2136d8d096d9d2033e3502 Mon Sep 17 00:00:00 2001 From: faxboss Date: Thu, 16 Nov 2017 20:57:26 +0100 Subject: [PATCH] Proposal for a updated README --- README.md | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bd16b7a..9520aed 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,17 @@ -# i2pdbrowser +#i2pdbrowser +-------- +### English i2pd browser bundle -todo: --------- -README \ No newline at end of file +This is a collection of scripts that will download the recent Firefox ESR release and configure it to connect over I2P, using i2pd. +A pre-built version for Windows is also included. + +##How to use it on Linux + +1. Build preconfigured FireFox using script `build.sh` from `build` folder +2. Run i2pd by executing `./i2pd` from `i2pd` folder +3. Run FireFox by executing `./firefox-portable` + +###TODO: +* English version of Windows how-to for using it. +* Russian translation of README, both this one and the one for /windows