From 9d336ae95520b46d427b67e2f5ddfb3fe5e117e7 Mon Sep 17 00:00:00 2001 From: Ribhav28 <153540042+Ribhav28@users.noreply.github.com> Date: Wed, 17 Jan 2024 13:50:39 +0530 Subject: [PATCH 1/2] Add emoji --- hp-docs/quick-start.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/hp-docs/quick-start.md b/hp-docs/quick-start.md index 2b7c71b..366e73c 100644 --- a/hp-docs/quick-start.md +++ b/hp-docs/quick-start.md @@ -14,9 +14,8 @@ description: A primer on Holepunch's modular building blocks ### Setup -{% hint style="warning" %} -Before we begin, make sure you are running Node v16 or greater. -{% endhint %} +> ⚠️ Before we begin, make sure you are running Node v16 or greater. + To follow along with this quick-start guide, download the [Holepunch examples repo](https://github.com/holepunchto/examples) From ef9e042c4c8735f26fbcc5c40470653bd29f7346 Mon Sep 17 00:00:00 2001 From: Ribhav28 <153540042+Ribhav28@users.noreply.github.com> Date: Wed, 17 Jan 2024 13:59:13 +0530 Subject: [PATCH 2/2] Improve text --- hp-docs/README.md | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/hp-docs/README.md b/hp-docs/README.md index f701d7e..9c877f6 100644 --- a/hp-docs/README.md +++ b/hp-docs/README.md @@ -41,7 +41,7 @@ Helper modules can be used together with the building blocks to create cutting-e
hypershell.mdA CLI to create and connect to P2P E2E encrypted shells.hypershell.md
hypertele.mdA swiss-knife proxy powered by hyperdht.md.hypertele.md
hyperbeam.mdA one-to-one and end-to-end encrypted internet pipe.hyperbeam.md
hyperssh.mdA CLI to run SSH over the hyperdht.md.hyperssh.md
drives.mdCLI to download, seed, and mirror a hyperdrive.md or a localdrive.md.drives.md
- These tools are extensively employed in the day-to-day development and operation of applications built on Holepunch, like [Keet.io](https://keet.io/). + ✔️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 @@ -84,13 +84,7 @@ Hypercores are single-writer data structures, but collaboration is crucial. [aut As Autobase's output shares the familiar Hypercore API, it is possible to plug it into higher-level modules like Hyperbee and Hyperdrive, getting a multi-user collaboration with little additional effort. -<<<<<<< HEAD -{% hint style="warning" %} -Autobase is still experimental and is likely to change significantly in the near future. 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! ->>>>>>> ea20f22852e518505a9bc5035bfc5ee1c67373ee + ⚠️ 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 @@ -118,4 +112,4 @@ The following stability indices have been used: | [hyperdht.md](building-blocks/hyperdht.md "mention") | **stable** | - 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. + ⚠️ 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.