From 2cb189bd31a16a7e5ece8bbeb627aaba0ffc19b6 Mon Sep 17 00:00:00 2001 From: ZeroNet Date: Mon, 12 Jan 2015 03:18:50 +0100 Subject: [PATCH] Update README.md How does it works?, Why?, Install --- README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 665641b2..bb5c2de6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,32 @@ # ZeroNet -ZeroNet + +#### Decentralized web platform using Bitcoin Crypto and BitTorrent network + +## How does it works? + - After starting `zeronet.py` you will be able to visit zeronet sites using http://127.0.0.1:43110/[zeronet_address] (eg. http://127.0.0.1:43110/1EU1tbG9oC1A8jz2ouVwGZyQ5asrNsE4Vr). + - When you visit a new zeronet site, its try to find peers using BitTorrent network and download the site files (html, css, js...) from them. + - Each visited sites become also served by You. + - Every site containing a `site.json` which holds all other files md5 hash and a sign generated using site's private key. + - If the site owner (the owner of the private key for the site) modifies the site, then he/she signs the new `content.json` and publish it to the peers. After the peers verified the `content.json` integrity using the sign they download the modified files and publish the new content to other peers. + +## Why? + - No single point of failure: Site goes on until at least 1 peer serving it + - No hosting costs: Served by people + - Works offline: You can access the site even if your internet is gone + +## Install +Windows: + - [Install Python 2.7](https://www.python.org/ftp/python/2.7.9/python-2.7.9.msi) + - [Install Python ZeroMQ](http://www.lfd.uci.edu/~gohlke/pythonlibs/girnt9fk/pyzmq-14.4.1.win32-py2.7.exe) + - [Install Python Gevent](http://www.lfd.uci.edu/~gohlke/pythonlibs/girnt9fk/gevent-1.0.1.win32-py2.7.exe) + - [Install Python MsgPack](http://zeronet.io/dep-windows/msgpack-python-0.4.2.win32-py2.7.exe) + - start zeronet.py + +Linux (Debian): + - `apt-get install python-pip` + - `pip install pyzmq` (if drops compile error then `apt-get install python-dev` and try again) + - `pip install gevent` + - `pip install msgpack-python` + - start zeronet.py + +