Skip to content

benchlab/dweb-readme-standard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 

Repository files navigation

dWeb Library Name

dWebShield-OfficialdWebShield-Auth
dWebShield

This area is reserved for a short description of the dWeb library, protocol, decentralized website or decentralized application you are launching on the dWeb.

Table of Contents

Background

Here we describe the background behind the library, protocol, website or application this README is connected to. It can be between 3-4 sentences but shouldn't be too long.

Installation

npm i --save dweb-library-name
yarn add dweb-library-name
dpack add dweb-library-name

Terms

  • termOne - Short description for termOne.
  • termTwo - Short description for termTwo.

Usage

dWeb Library Code Here

API

Note: If your library or repository doesn't have any sort of API, this section can be deleted. Don't forget to remove from the table of contents.

var vault = ddrive(dstorage, [dkey], [options])

This is a description of what it does.

This is a longer description of what it does. Should be several sentences and give an intro to the following lines, which should explain the process behind the code and what the end result is.

  • This should describe the first part of the process.

  • This should describe the next part of the process.

  • This might describe some arguments that are made in the above API call:

    • fileName: this should be the name of the file we are storing within the given dDrive (Distributed Drive).
    • dwOpts
    • dvault: the current dDrive being accessed.

Important: These functions need to return a dwRam instance.

Options include:

{
  thin: true, // this allows the ddrive to only retreive data that it is requested to retreive. 
  thinMd: true // this allows the ddrive to only retreive data via a metadata feed that it is requested to retreive.
  MDSCS: 65536 // the number of items to use in the  metadata `dRecord` `Least Recently Used` cache.
  CSCS: 65536 // the number of items to use in the content `dRecord` `Least Recently Used` cache.
  MTCS: 65536 // the number of items to use in the `affixTree`'s `Least Recently Used` cache.
}

Note: Snapshotted dDrive vault can be "thin". You can do this by enabling the thin: true option. In this way, records that are being fed to the dDrive won't be accepted unless it's specifically asked to do so. If you want the thinnest possible dDrive, it would also be wise to enable thinMd: true for the same effect as thin:true, except with MetaData.

Related Projects

Why The Internet Must Have A Decentralized Alternative

Today, the internet is more censored than ever and it's only getting worse. Our mission with the dWeb Protocol was to create a truly powerful P2P protocol, around benOS, dBrowser and many of benOS' underlying libraries to bring the most powerful P2P products to life. In the last few months, by rebuilding P2P technologies that have existed since the early 2000s, we have built a powerful suite of decentralized libraries for benOS and the Bench Network, that will only improve over time. But we also brought new ideas to life, like:

and more! These were the protocols and libraries that we needed to create a completely decentralized operating system, where everything was distributed, protected and people were once again in control of their data. benOS is made up of over 1100+ different libraries that we are releasing on a day-by-day basis as we move them to a stable/production state. While financial support is great for this open source project, we need developers who want to be some of the first to build the dApps and dSites of the future. We have to take back what our forefathers originally designed for freedom, by making our code the law, instead of releasing weak and highly centralized applications where law cannot be applied because the code lacks the foundation to implement a legal framework for itself. Join us for a truly historic journey on the BenchLabs Telegram. See you there.

Bench On The dWeb

dweb://bench.dnames.io // dNames Short Link dweb://3EDAE09848B77401445B7739CAFCE442DDE1752AED63025A1F94E6A86D7E9F04 // dWeb Key Link

In order to make the links above clickable or to view these links period, you will need dBrowser (Available for Mac OSX, Linux, Windows and soon to be available on iOS/Android)

"The Code Is The Law" - Stan Larimer - Godfather of BitShares.

License

MIT

Copyright

Copyright (c) 2018 Bench Computer, Inc. All rights reserved.

Releases

No releases published

Packages

No packages published