From f905f019a6dc72a851433af2764c242fa86242a7 Mon Sep 17 00:00:00 2001 From: Ashley Perpetual Date: Wed, 2 Mar 2016 18:24:06 +0800 Subject: [PATCH 1/4] Added virtualenv section to README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 52d24d1f..bc792db3 100644 --- a/README.md +++ b/README.md @@ -116,6 +116,13 @@ It downloads the latest version of ZeroNet then starts it automatically. * `docker run -p 15441:15441 -p 43110:43110 nofish/zeronet` * Open http://127.0.0.1:43110/ in your browser +### Virtualenv + +* virtualenv env +* . env/bin/activate +* pip install msgpack-python gevent +* python zeronet.py + ## Current limitations * No torrent-like, file splitting for big file support From 00503b596a10b31effa805ebb79e35c055e13eff Mon Sep 17 00:00:00 2001 From: Ashley Perpetual Date: Wed, 2 Mar 2016 18:38:15 +0800 Subject: [PATCH 2/4] Edited Virtualenv section in README.md to use fixed-width characters for commands, added 'browse' instruction below it --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index bc792db3..c590f01d 100644 --- a/README.md +++ b/README.md @@ -118,10 +118,11 @@ It downloads the latest version of ZeroNet then starts it automatically. ### Virtualenv -* virtualenv env -* . env/bin/activate -* pip install msgpack-python gevent -* python zeronet.py +* `virtualenv env` +* `. env/bin/activate` +* `pip install msgpack-python gevent` +* `python zeronet.py` +* Open http://127.0.0.1:43110/ in your browser ## Current limitations From 1c0be2e5ce58ccf0e07627cecb6ef7fc1dcf6681 Mon Sep 17 00:00:00 2001 From: Ashley Perpetual Date: Wed, 2 Mar 2016 19:50:36 +0800 Subject: [PATCH 3/4] Modified readme to fix typos, add some links, etc --- README.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index c590f01d..c0676c55 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,12 @@ Decentralized websites using Bitcoin crypto and the BitTorrent network - https:/ ## Why? -* We believe in open, free, and uncensored network and communication. -* No single point of failure: Site remains online so long as at least 1 peer +* We believe in open, free, and uncensored networking and communication. +* No single point of failure: Site remains online so long as at least 1 peer is serving it. * No hosting costs: Sites are served by visitors. * Impossible to shut down: It's nowhere because it's everywhere. -* Fast and works offline: You can access the site even if your internet is +* Fast and works offline: You can access the site even if Internet is unavailable. @@ -20,11 +20,11 @@ Decentralized websites using Bitcoin crypto and the BitTorrent network - https:/ * Easy to setup: unpack & run * Clone websites in one click * Password-less [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) - based authorization: Your account is protected by same cryptography as your Bitcoin wallet + based authorization: Your account is protected by the same cryptography as your Bitcoin wallet * Built-in SQL server with P2P data synchronization: Allows easier site development and faster page load times - * Anonymity: Full Tor network support with .onion hidden services instead of ipv4 addresses + * Anonymity: Full Tor network support with .onion hidden services instead of IPv4 addresses * TLS encrypted connections - * Automatic, uPnP port opening + * Automatic uPnP port opening * Plugin for multiuser (openproxy) support * Works with any browser/OS @@ -36,12 +36,12 @@ Decentralized websites using Bitcoin crypto and the BitTorrent network - https:/ `http://127.0.0.1:43110/1HeLLo4uzjaLetFx6NH3PMwFP3qbRbTf3D`). * When you visit a new zeronet site, it tries to find peers using the BitTorrent network so it can download the site files (html, css, js...) from them. -* Each visited site becomes also served by you. -* Every site contains a `content.json` which holds all other files in a sha512 hash - and a signature generated using site's private key. +* Each visited site is also served by you. +* Every site contains a `content.json` file which holds all other files in a sha512 hash + and a signature generated using the site's private key. * If the site owner (who has the private key for the site address) modifies the site, then he/she signs the new `content.json` and publishes it to the peers. - After the peers have verified the `content.json` integrity (using the + Afterwards, the peers verify the `content.json` integrity (using the signature), they download the modified files and publish the new content to other peers. @@ -59,7 +59,7 @@ Decentralized websites using Bitcoin crypto and the BitTorrent network - https:/ #### [More screenshots in ZeroNet docs ยป](https://zeronet.readthedocs.org/en/latest/using_zeronet/sample_sites/) -## How to join? +## How to join ### Windows @@ -92,7 +92,7 @@ It downloads the latest version of ZeroNet then starts it automatically. * Open http://127.0.0.1:43110/ in your browser and enjoy! :) #### Other Linux or without root access -* Check your python version using `python --version` if the returned version is not `Python 2.7.X` then try `python2` or `python2.7` command and use it from now +* Check your python version using `python --version`. if the returned version is not `Python 2.7.X` then try `python2` or `python2.7` command and use it from now on * `wget https://bootstrap.pypa.io/get-pip.py` * `python get-pip.py --user gevent msgpack-python` * Start with `python zeronet.py` @@ -104,7 +104,7 @@ It downloads the latest version of ZeroNet then starts it automatically. * `pip install gevent msgpack-python` * [Download](https://github.com/HelloZeroNet/ZeroNet/archive/master.zip), Unpack, run `python zeronet.py` -### Vagrant +### [Vagrant](https://www.vagrantup.com/) * `vagrant up` * Access VM with `vagrant ssh` @@ -112,11 +112,11 @@ It downloads the latest version of ZeroNet then starts it automatically. * Run `python zeronet.py --ui_ip 0.0.0.0` * Open http://127.0.0.1:43110/ in your browser -### Docker +### [Docker](https://www.docker.com/) * `docker run -p 15441:15441 -p 43110:43110 nofish/zeronet` * Open http://127.0.0.1:43110/ in your browser -### Virtualenv +### [Virtualenv](https://virtualenv.readthedocs.org/en/latest/) * `virtualenv env` * `. env/bin/activate` @@ -126,7 +126,7 @@ It downloads the latest version of ZeroNet then starts it automatically. ## Current limitations -* No torrent-like, file splitting for big file support +* No torrent-like file splitting for big file support * ~~No more anonymous than Bittorrent~~ (built-in full Tor support added) * File transactions are not compressed ~~or encrypted yet~~ (TLS encryption added) * No private sites @@ -177,7 +177,7 @@ Site:13DNDk..bhC2 Successfuly published to 3 peers * That's it! You've successfully signed and published your modifications. -## If you want to help keep this project alive +## Donate - Bitcoin: 1QDhxQ6PraUZa21ET5fYUCPgdrwBomnFgX - Paypal: https://zeronet.readthedocs.org/en/latest/help_zeronet/donate/ From 7ea86a1e8a5bdc4417cdea66dcfe3e6b6629b6be Mon Sep 17 00:00:00 2001 From: Ashley Perpetual Date: Thu, 3 Mar 2016 17:38:25 +0800 Subject: [PATCH 4/4] Changed '.' to 'source' in virtualenv section of README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c0676c55..285afc5b 100644 --- a/README.md +++ b/README.md @@ -119,7 +119,7 @@ It downloads the latest version of ZeroNet then starts it automatically. ### [Virtualenv](https://virtualenv.readthedocs.org/en/latest/) * `virtualenv env` -* `. env/bin/activate` +* `source env/bin/activate` * `pip install msgpack-python gevent` * `python zeronet.py` * Open http://127.0.0.1:43110/ in your browser