fluencelabs/dweb-transports
1
0
Fork 0
mirror of https://github.com/fluencelabs/dweb-transports synced 2025-03-15 18:30:49 +00:00
Code Issues Projects Releases Wiki Activity

Docs

Browse Source
This commit is contained in:
Mitra Ardron 2018-04-27 11:52:16 +10:00
parent 37e9d9507f
commit 30077716a3
2 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
API.md
View File

@ -1,7 +1,7 @@
#dweb-transports API
Mitra Ardron, Internet Archive, mitra@mitra.biz
This doc provides a concise API specification for the Dweb Javascript Libraries.
This doc provides a concise API specification for the Dweb Javascript Transports Libraries.
It was last revised (to match the code) on 23 April 2018.

18
README.md
View File

@ -3,7 +3,7 @@ General transport library for Decentralized Web handles multiple underlying tran
## Background
This library is part of a general project at the Internet Archive (archive.org)
to support the decentralized web.
to support the decentralized web.
### Goals
* to allow a single API that can be used for most basic interactions with
@ -14,9 +14,8 @@ decentralized transports.
### Node Installation
* Clone this repo.
* Until this is in npm, add the line
`"dweb-transports": "git+https://git@github.com/mitra42/dweb-transports.git",`
`"dweb-transports": "git+https://git@github.com/internetarchive/dweb-transports.git",`
to your package.json file in the dependencies section.
* (TODO Note location above will change to an internetarchive repo)
* `npm install dweb-transports` will install the dependencies including IPFS & WebTorrent
`const DwebTransports = require(dweb-transport)` will add all Transports to a Javascript file.
@ -24,7 +23,6 @@ to your package.json file in the dependencies section.
* Then see usage API below
### Installation and usage in the Browser
* TODO installation of dev dependencies
* Install npm & node
* Clone this repo and cd to it.
* `npm bundle` will create dist/dweb_transports_bundle.js
@ -55,3 +53,15 @@ var verbose = searchparams.get("verbose") || false;
See [example_block.html](./example_block.html) for an example of connecting, storing and retrieving.
See [API.md](./API.md) for the detailed API.
##See related:
* [Archive.org](http://dweb.archive.org/details) bootstrap into the Archive's page
* [Examples](http://dweb.me/examples) examples
###Repos:
* *dweb-transports:* Common API to underlying transports (http, webtorrent, ipfs, yjs)
* *dweb-objects:* Object model for Dweb inc Lists, Authentication, Key/Value, Naming
* *dweb-serviceworker:* Run Transports in ServiceWorker (experimental)
* *dweb-archive:* Decentralized Archive webpage and bootstrapping
* *dweb-transport:* Original Repo, still includes examples but being split into smaller repos