diff --git a/README.md b/README.md index 9fd3ac5..d6a19a0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,42 @@ # IPFS Boards -This is a branch with a brand new implementation of boards. Nothing works yet +Boards is an experiment with the goal of figuring out whether it's possible to have +a discussion board, forum or social network that works inside a normal browser tab +without relying on servers, desktop applications, browser extensions, the blockchain +or anything else. + +The goals in detail: + +- all communication should happen in the most distributed way possible using +peer to peer systems +- should work completely offline without anything else other than a web browser +after it's downloaded for the first time +- all data including assets, code and user created content needs to be distributed +and/or replicated between the users + +The project is in prototype stage and works thanks to the [IPFS](https://ipfs.io) +distributed file system. + +You're looking at the new implementation of Boards. If you want to check out the +old one [follow this link](https://github.com/fazo96/ipfs-boards) + +The first iteration focuses on creating boards, posting content and commenting. +Moderation tools, encryption, friends lists, private messages, real time chat and +other features will be attempted in the future + +## Try it out + +There is no public build yet, check out the next section + +## Working on the code + +This is a react project using redux, react-router-redux and redux-saga + +The UI is being implemented using semantic-ui-react + +Clone this repo, then run + +- `yarn` to install dependencies +- `yarn start` to start a development server +- `yarn run build` to create a production build -[Check out the old version](https://github.com/fazo96/ipfs-boards)