From 732c25cf54b5c4cfbead851028dc68cf48d61fad Mon Sep 17 00:00:00 2001 From: Enrico Fasoli Date: Sun, 15 Nov 2015 21:35:37 +0100 Subject: [PATCH] improved documentation --- PROTOCOL.md | 9 ++++++--- README.md | 4 ++++ 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/PROTOCOL.md b/PROTOCOL.md index a172cb1..8ef22be 100644 --- a/PROTOCOL.md +++ b/PROTOCOL.md @@ -8,7 +8,8 @@ In a nutshell, it works like this: - IPFS is fully distributed, and safe, because anyone can verify some data actually matches the address - IPFS is efficient because anyone that views some content caches it and helps redistribute it. Your machines however will never redistribute data you haven't viewed or downloaded - IPNS associates an IPFS address to the address of a node, it works like a pointer to track data that changes over time -- This project's discovery and storage protocols are entirely based on IPNS and IPFS +- IPNS publications are signed from the node matching the publication's actual address, so they can be trusted +- This project's discovery, storage and communications protocols are entirely based on IPNS and IPFS __Data Storage:__ A user's profile, posts, votes, comments and all his other data is served by him and stored in his computer(s). Anyone that views his content will cache it by default thus helping others to see his profile. That's why if hundreds of people open the profile page of some @@ -145,9 +146,11 @@ Your computer will always be able to choose what to see and what to hide, it jus They monitor _administrations_ and cache all the content (or some of it) as soon as it becomes available on the network, making sure it never gets lost. -They are completely optional but they help out in serving the users. +They are completely optional but they help out, making the system faster and +more stable and consistent. -Cache servers also act as gateways and provide an HTTP API to access the boards. +Cache servers can also act as gateways and provide an HTTP +or WebSocket API to access the boards when IPFS is not available. Also note that due to how IPFS works, the more popular some content gets, the _faster it downloads_ and the _easier it is for your computer to find it_. diff --git a/README.md b/README.md index 33a3031..e6f5518 100644 --- a/README.md +++ b/README.md @@ -69,6 +69,10 @@ Ability to publish stuff in the browser won't be implemented until go-ipfs 0.4 is ready. It will maybe be ready before the new year. You will be able to publish your boards/profile/posts using a CLI though. +### How do I set up a development environment? + +See `HACKING.md` + ## Components - __Client__