From cb9322bbeeaa758c9b068164d07b55da617abe74 Mon Sep 17 00:00:00 2001 From: rafapaezbas <15270736+rafapaezbas@users.noreply.github.com> Date: Fri, 16 Feb 2024 14:41:41 +0100 Subject: [PATCH] label as experimental pear apis (#51) Co-authored-by: rafapaezbas --- readme.md | 49 ++++++++++++++++---------------------- reference/api.md | 4 ++-- reference/cli.md | 2 +- reference/configuration.md | 2 +- 4 files changed, 24 insertions(+), 33 deletions(-) diff --git a/readme.md b/readme.md index 4b74490..10bb56a 100644 --- a/readme.md +++ b/readme.md @@ -37,18 +37,24 @@ Welcome to the Internet of Peers * [How to share append-only databases with Hyperbee](./howto/share-append-only-databases-with-hyperbee.md) * [How to create a full peer-to-peer filesystem with Hyperdrive](./howto/create-a-full-peer-to-peer-filesystem-with-hyperdrive.md) + +## Stability indexing + +Throughout the documentation, indications of stability are provided. Some modules are well-established and used widely, making them highly unlikely to ever change. Other modules may be new, experimental, or known to have risks associated with their use. + +The following stability indices have been used: + +| Stability | Description | +| :----------------------------------------------------------: | :---------------------------------------------------------: | +| **stable** | Unlikely to change or be removed in the foreseeable future. | +| **experimental** | New, untested, or have known issues. | +| **deprecated** | Being removed or replaced in the future. | +| **unstable** | May change or be removed without warning. | + + ## Building blocks -| Module | Stability | -| ------------------------------------------------| :----------------------------------------------------------: | -| [`hypercore`](./building-blocks/hypercore.md) | **stable** | -| [`hyperbee`](./building-blocks/hyperbee.md) | **stable** | -| [`hyperdrive`](./building-blocks/hyperdrive.md) | **stable** | -| [`autobase`](./building-blocks/autobase.md) | **experimental** | -| [`hyperswarm`](./building-blocks/hyperswarm.md) | **stable** | -| [`hyperdht`](./building-blocks/hyperdht.md) | **stable** | - -### Hypercore +### Hypercore **stable** The [`hypercore`](./building-blocks/hypercore.md) module is a distributed, secure append-only log for creating fast and scalable applications without a backend, as it is entirely peer-to-peer. @@ -60,7 +66,7 @@ Notable features include: * The [`session`](./building-blocks/hypercore.md#core.session-options) and [`snapshot`](./building-blocks/hypercore.md#core.snapshot-options) methods for providing multiple views over the same underlying Hypercore, which simplifies resource management. * A [`truncate`](./building-blocks/hypercore.md#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). -### Hyperswarm +### Hyperswarm **stable** The [`hyperswarm`](./building-blocks/hyperswarm.md) module is a high-level API for finding and connecting to peers who are interested in a "topic." @@ -70,7 +76,7 @@ Notable features include: * 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. -### Hyperdrive +### Hyperdrive **stable** The [`hyperdrive`](./building-blocks/hyperdrive.md) module is a secure, real-time distributed file system that simplifies P2P file sharing that provides an efficient way to store and access data across multiple connected devices in a decentralized manner. @@ -78,7 +84,7 @@ The [`hyperdrive`](./building-blocks/hyperdrive.md) module is a secure, real-tim * 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. -### Autobase (experimental) +### Autobase **experimental** The [`autobase`](./building-blocks/autobase.md) experimental module provides a "virtual Hypercore" layer over many Hypercores owned by many different peers. @@ -89,7 +95,7 @@ Notable features include: > Autobase is still experimental and is likely to change significantly in the near future. -### Hyperdht +### Hyperdht **stable** The `hyperdht` module is the Distributed Hash Table (DHT) powering Hyperswarm. Through this DHT, each server is bound to a unique key pair, with the client connecting to the server using the server's public key. @@ -119,18 +125,3 @@ The following tools are used extensively employed in the day-to-day development | **[Hyperbeam](./tools/hyperbeam.md)** | A one-to-one and end-to-end encrypted internet pipe. | | **[Hyperssh](./tools/hyperssh.md)** | A CLI to run SSH over the [HyperDHT](./building-blocks/hyperdht.md). | | **[Drives](./tools/drives.md)** | CLI to download, seed, and mirror a [hyperdrive](./building-blocks/hyperdrive.md) or a [localdrive](./helpers/localdrive.md). | - - -## Stability indexing - -Throughout the documentation, indications of stability are provided. Some modules are well-established and used widely, making them highly unlikely to ever change. Other modules may be new, experimental, or known to have risks associated with their use. - -The following stability indices have been used: - -| Stability | Description | -| :----------------------------------------------------------: | :---------------------------------------------------------: | -| **stable** | Unlikely to change or be removed in the foreseeable future. | -| **experimental** | New, untested, or have known issues. | -| **deprecated** | Being removed or replaced in the future. | -| **unstable** | May change or be removed without warning. | - diff --git a/reference/api.md b/reference/api.md index d308d87..0fbdb5b 100644 --- a/reference/api.md +++ b/reference/api.md @@ -1,4 +1,4 @@ -# Application Programming Interface (API) +# Application Programming Interface (API) **experimental** The Pear API enables applications to interact with Pear platform features. @@ -953,4 +953,4 @@ Like browsers, there is support for native EcmaScript Modules (ESM). A JavaScrip Use `