Added Keet + trimmed down README.md (#59)

* added Keet + structural changes

* Fixed headings

* Updated README.md

* Removed tables

* Fix syntax

---------

Co-authored-by: Subash <subash@vuln.in>
This commit is contained in:
Subash SN
2024-02-20 16:15:36 +01:00
committed by GitHub
parent ddc68c0199
commit dd1bc41fc7
12 changed files with 110 additions and 87 deletions

View File

@@ -6,6 +6,10 @@ Autobase is used to automatically rebase multiple causally-linked Hypercores int
> Although Autobase is still under development, it finds application in many active projects. Keet rooms, for example, are powered by Autobase! This is a testament to the potential of Autobase, and we are excited to see what else it can achieve.
Notable features include:
* automatic rebasing of multiple causally-linked Hypercores into a single, linearized Hypercore for multi-user collaboration
* low-friction integration into higher-level modules like Hyperbee and Hyperdrive: Autobase's output shares the familiar Hypercore API so peer-to-peer multi-user collaboration is achievable with little additional implementation effort.
> [GitHub (Autobase)](https://github.com/holepunchto/autobase)

View File

@@ -6,7 +6,6 @@ Hyperbee is an append only B-tree based on [`Hypercore`](hypercore.md). It provi
> As with the Hypercore, a Hyperbee can only have a **single writer on a single machine**; the creator of the Hyperdrive is the only person who can modify it as they're the only one with the private key. That said, the writer can replicate to **many readers**, in a manner similar to BitTorrent.
> [GitHub (Hyperbee)](https://github.com/holepunchto/hyperbee)
* [Hyperbee](../building-blocks/hyperbee.md):

View File

@@ -4,6 +4,14 @@
Hypercore is a secure, distributed append-only log built for sharing large datasets and streams of real-time data. It comes with a secure transport protocol, making it easy to build fast and scalable peer-to-peer applications.
Notable features include:
* Improved fork detection in the replication protocol, to improve resilience.
* Optional on-disk encryption for blocks (in addition to the existing transport encryption).
* A write-ahead log in the storage layer to ensure that power loss or unexpected shutdown cannot lead to data corruption.
* The [`session`](#core.session-options) and [`snapshot`](#core.snapshot-options) methods for providing multiple views over the same underlying Hypercore, which simplifies resource management.
* A [`truncate`](#await-core.truncate-newlength-forkid) method for intentionally creating a new fork, starting at a given length. We use this method extensively in [`autobase`](../building-blocks/autobase.md).
> [GitHub (Hypercore)](https://github.com/holepunchto/hypercore)
* [Hypercore](../building-blocks/hypercore.md)

View File

@@ -6,6 +6,10 @@ The DHT powering Hyperswarm and built on top of [dht-rpc](https://github.com/maf
In the HyperDHT, peers are identified by a public key, not by an IP address. A public key can be connected regardless of where the peers are located, even if they move between different networks.
Notable features include:
* lower-level module provides direct access to the DHT for connecting peers using key pairs
> [GitHub (Hyperdht)](https://github.com/holepunchto/hyperdht)
* [HyperDHT](../building-blocks/hyperdht.md)

View File

@@ -4,6 +4,12 @@
Hyperdrive is a secure, real-time distributed file system designed for easy P2P file sharing. We use it extensively inside Holepunch; apps like Keet are distributed to users as Hyperdrives, as is the Holepunch platform itself.
Notable features include:
* Uses Hyperbee internally for storing file metadata
* Major API simplification. Instead of mirroring POSIX APIs, the new API better captures the core requirements of P2P file transfer.
* Auxiliary tools, [`localdrive`](./helpers/localdrive.md) and [`mirrordrive`](./helpers/mirrordrive.md), that streamline import/export flows and make it easy to mirror drives to and from the local filesystem.
> [GitHub (Hyperdrive)](https://github.com/holepunchto/hyperdrive)
* [Hyperdrive](../building-blocks/hyperdrive.md)

View File

@@ -6,6 +6,12 @@ Hyperswarm helps to find and connect to peers announcing a common 'topic' that c
Hyperswarm offers a simple interface to abstract away the complexities of underlying modules such as [HyperDHT](hyperdht.md) and [SecretStream](../helpers/secretstream.md). These modules can also be used independently for specialized tasks.
Notable features include:
* An improved UDP holepunching algorithm that uses arbitrary DHT nodes (optionally selected by the connecting peers) to proxy necessary metadata while being maximally privacy-preserving.
* A custom-built transport protocol, [UDX](https://github.com/hyperswarm/libudx), that takes advantage of the holepunching algorithm to avoid unnecessary overhead (it doesn't include handshaking since holepunching takes care of that, for example). It's blazing fast.
* A simplified DHT API that closely resembles NodeJS's `net` module, but using public keys instead of IP addresses.
> [GitHub (Hyperswarm)](https://github.com/hyperswarm/hyperswarm)
* [Hyperswarm](../building-blocks/hyperswarm.md)