Fleshing out description + dev usage.

This commit is contained in:
Dan 2017-12-10 11:46:03 -08:00
parent 87062b178d
commit 785db48136
1 changed files with 24 additions and 5 deletions

View File

@ -1,22 +1,41 @@
## Intergalactic
Intergalactic is a client-side gateway to the IPFS distributed web. Other than
bootstrapping, it runs entirely in your browser without using any servers.
Intergalactic is a client-side gateway to the IPFS distributed web. After the
initial page load and bootstrapping, it pulls content from IPFS peers entirely
in your browser.
## Motivation
This project aims to bring the distributed web to anyone with a web browser,
without having to download any software or go through a centralized gateway.
Intergalactic brings the distributed web to anyone with a web browser. This
allows web developers and content producers to publish their content through
IPFS, while still allowing users to consume it. All without having to download
any software or go through a centralized gateway.
## Installation
```shell
npm install
node server.js
```
TODO
## Usage
### Development
First, run the following from your copy of Intergalactic's source code:
```shell
node server.js
```
Then, enter a URL like `http://localhost:3000/ipfs/<hash>` into your web
browser, where `<hash>` is the IPFS hash of some content on the network.
If the corresponding content is loadable, it will load and render in your
browser.
### Production
TODO