Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.56 KB

README.md

File metadata and controls

47 lines (32 loc) · 1.56 KB
Raw

Peer Zero

Build Status codecov Downloads NPM

js-standard-style

ZeroNet-related functions implemented in pure JavaScript.

getFile

Returns a promise for the file data (will download from a remote peer to local storage if needed) for the requested zite.

const file = await peer0.getFile(ziteAddr, filePath)

getInfo

Returns a promise for a summary of information (read from content.json) for the requested zite.

const info = await peer0.getInfo(ziteAddr)
  1. Title (required)
  2. Description (required)
  3. Image Icon (min: 32px² | max: 1024px²)
  4. Image Banner
  5. Screenshots
  6. Content Rating
  7. Tags (keywords)
  8. Tagline (short <200 char description, typically displayed in searches)
  9. Built-in Plugins (chat, forum, dropbox, etc)

Development Roadmap — 2018

  • Connect & communicate with ZeroNet peers via TCP.
  • Connect & communicate with Torrent trackers via UDP.
  • Blockchain integrations
    • Bitcoin (BitcoinJS)
    • Ethereum (Ethers.io)
    • IPFS

Development Roadmap — 2019

coming soon...

Released under the terms of the MIT LICENSE.