From b69cc3dbee8b87fa58e8325f426e80f6a6bc596d Mon Sep 17 00:00:00 2001
From: 0x1eef <0x1eef@protonmail.com>
Date: Wed, 7 Aug 2024 02:39:09 -0300
Subject: [PATCH] Update docs (README.md)
---
README.md | 24 ++++++++++--------------
1 file changed, 10 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index 7a927a7..09a0d4d 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ The copy of the ports tree is maintained by members of
the `_portzap` group, and the copy of the ports tree
can be installed into `/usr/ports/` by root.
-## Examples
+## CLI
### CLI: setup-portzap
@@ -25,16 +25,16 @@ restricted to members of the `_portzap` group. The restrictions
are enforced by portzap and to a lesser extent by
[doas(1)](https://man.openbsd.org/doas):
-**portzap clone**
+* **portzap clone**
Clone the HardenedBSD ports tree into `/home/_portzap/ports/`
-**portzap pull**
+* **portzap pull**
Pull updates into `/home/_portzap/ports/`
-**portzap checkout**
+* **portzap checkout**
Checkout a branch other than the default: `hardenedbsd/main`
-**portzap sh**
+* **portzap sh**
Run `/bin/sh` within `/home/_portzap/ports/`
### CLI: superuser
@@ -42,10 +42,10 @@ Run `/bin/sh` within `/home/_portzap/ports/`
The following commands are restricted to root.
The restrictions are enforced by portzap:
-**portzap rm**
+* **portzap rm**
Remove the contents of `/usr/ports/` and `/home/_portzap/ports/`
-**portzap install**
+* **portzap install**
Install `/home/_portzap/ports/` into `/usr/ports/`
## Environment
@@ -60,15 +60,11 @@ Install `/home/_portzap/ports/` into `/usr/ports/`
## Install
-#### Package
portzap is available
-[from the HardenedBSD ports tree](https://git.HardenedBSD.org/HardenedBSD/ports/-/tree/HardenedBSD/main/hardenedbsd/portzap).
-`pkg install portzap` should work too but expect slower updates.
-
-#### Git
-
-The most recent version of portzap can be installed via git:
+[from the HardenedBSD ports tree](https://git.HardenedBSD.org/HardenedBSD/ports/-/tree/HardenedBSD/main/hardenedbsd/portzap).
+`pkg install portzap` should work too but expect slower updates. The most
+recent version of portzap can be installed via git:
# Clone
user@localhost$ git clone https://git.hardenedbsd.org/0x1eef/portzap.git