aljaz/pear-docs
1
0
Fork 0
mirror of https://github.com/aljazceru/pear-docs.git synced 2025-12-17 14:34:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update ReadMe

Browse Source
This commit is contained in:
Ribhav28
2024-01-17 12:35:40 +05:30
committed by GitHub
parent a1e9a3cb41
commit 48ec9e2212
1 changed files with 7 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
hp-docs/README.md
View File

@@ -1,5 +1,5 @@
---
description: Welcome to the Holepunch docs! 👋
description: Welcome to the Pear docs! 👋
---
# Pear by Holepunch
@@ -42,9 +42,8 @@ Helper modules can be used together with the building blocks to create cutting-e
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><a data-mention href="tools/hypershell.md">hypershell.md</a></td><td>A CLI to create and connect to P2P E2E encrypted shells.</td><td></td><td><a href="tools/hypershell.md">hypershell.md</a></td></tr><tr><td><a data-mention href="tools/hypertele.md">hypertele.md</a></td><td>A swiss-knife proxy powered by <a data-mention href="building-blocks/hyperdht.md">hyperdht.md</a>.</td><td></td><td><a href="tools/hypertele.md">hypertele.md</a></td></tr><tr><td><a data-mention href="tools/hyperbeam.md">hyperbeam.md</a></td><td>A one-to-one and end-to-end encrypted internet pipe.</td><td></td><td><a href="tools/hyperbeam.md">hyperbeam.md</a></td></tr><tr><td><a data-mention href="tools/hyperssh.md">hyperssh.md</a></td><td>A CLI to run SSH over the <a data-mention href="building-blocks/hyperdht.md">hyperdht.md</a>.</td><td></td><td><a href="tools/hyperssh.md">hyperssh.md</a></td></tr><tr><td><a data-mention href="tools/drives.md">drives.md</a></td><td>CLI to download, seed, and mirror a <a data-mention href="building-blocks/hyperdrive.md">hyperdrive.md</a> or a <a data-mention href="helpers/localdrive.md">localdrive.md</a>.</td><td></td><td><a href="tools/drives.md">drives.md</a></td></tr></tbody></table>
{% hint style="success" %}
These tools are extensively employed in the day-to-day development and operation of applications built on Holepunch, like [Keet.io](https://keet.io/).
{% endhint %}
These tools are extensively employed in the day-to-day development and operation of applications built on Holepunch, like [Keet.io](https://keet.io/).
## Applications built using Holepunch
@@ -86,9 +85,8 @@ Hypercores are single-writer data structures, but collaboration is crucial. [aut
Since Autobase's output shares the familiar Hypercore API, you can plug it into higher-level modules like Hyperbee and Hyperdrive, getting a multi-user collaboration with little additional effort.
{% hint style="warning" %}
Autobase is still experimental and is likely to change significantly in the near future. If you're feeling adventurous, give it a shot!
{% endhint %}
Autobase is still experimental and is likely to change significantly in the near future. If you're feeling adventurous, give it a shot!
## Stability indexing
@@ -114,6 +112,5 @@ The following stability indices have been used:
| [hyperswarm.md](building-blocks/hyperswarm.md "mention") | <mark style="background-color:green;">**stable**</mark> |
| [hyperdht.md](building-blocks/hyperdht.md "mention") | <mark style="background-color:green;">**stable**</mark> |
{% hint style="warning" %}
Any part of a module (method, event, or property) that is not documented as part of that module's public API is subject to change at any time.
{% endhint %}
Any part of a module (method, event, or property) that is not documented as part of that module's public API is subject to change at any time.