fazo96/ipfs-boards
1
0
Fork 0
mirror of https://github.com/fazo96/ipfs-boards synced 2025-01-26 15:04:19 +01:00
Code Issues Releases Wiki Activity

improved documentation

Browse Source
This commit is contained in:
Enrico Fasoli 2015-11-15 21:35:37 +01:00
parent 23ffa38601
commit 732c25cf54
2 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
PROTOCOL.md
View File

@ -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 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 - 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 - 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 __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 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) 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. 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, 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_. the _faster it downloads_ and the _easier it is for your computer to find it_.

4
README.md
View File

@ -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. 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. 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 ## Components
- __Client__ - __Client__