From f937372f9a6958467c7926d67e194acf7255963d Mon Sep 17 00:00:00 2001
From: 0x1eef <0x1eef@protonmail.com>
Date: Fri, 9 Jun 2023 21:25:23 -0300
Subject: [PATCH] README: update
---
README.md | 64 +++++++++++++++++++++++--------------------------------
1 file changed, 27 insertions(+), 37 deletions(-)
diff --git a/README.md b/README.md
index 96478b5..1385008 100644
--- a/README.md
+++ b/README.md
@@ -1,60 +1,50 @@
## About
-portzap is designed to allow unprivileged users who are members
-of the `_portzap` group to create and update a transient copy of
-the HardenedBSD ports tree, which can then be installed into the
-`/usr/ports/` directory by root. Once the initial installation
-is complete, future updates are incremental, which means that portzap
-will only add, remove or update ports that have changed since the last
-update.
+portzap is a utility that manages a local copy of the
+[hardenedbsd ports tree](https://git.hardenedbsd.org/hardenedbsd/ports),
-## Usage
+## Examples
-**Commands**
+**CLI**
-* __portzap clone__
- Clones the ports tree into `/home/_portzap/ports/`.
+ # Clones the ports tree into "/home/_portzap/ports/"
+ $ portzap clone
-* __portzap pull__
- Pulls updates into `/home/_portzap/ports/`.
+ # Pulls updates into "/home/_portzap/ports/"
+ $ portzap pull
-* __portzap install__
- Installs `/home/_portzap/ports/` into `/usr/ports/`.
+ # Installs "/home/_portzap/ports/" into "/usr/ports/"
+ # portzap install
-**Environment variables**
+**Environment**
-* __$PORTZAP_PORTS_URL__
- The URL of a git repository.
- Defaults to https://git.hardenedbsd.org/hardenedbsd/ports.git.
+ # The URL of a git repository
+ # Defaults to https://git.hardenedbsd.org/hardenedbsd/ports.git
+ export PORTZAP_PORTS_URL=https://github.com/HardenedBSD/ports
+
+ # The directory where the ports collection will be installed
+ # Defaults to "/usr/ports/"
+ export PORTZAP_PORTS_DIR=/path/to/ports
## Install
-portzap can be installed through git, or via a port.
-The port makes installation, and deinstallation easier.
-
-__Port__
-
-See [0x1eef/ports/freebsd/hardenedbsd/portzap](https://git.hardenedbsd.org/0x1eef/ports/-/tree/main/freebsd/hardenedbsd/portzap).
-
-__Git__
-
```
-git clone https://git.hardenedbsd.org/0x1eef/portzap.git
-cd portzap
-cp -R bin /usr/local/
-cp -R libexec /usr/local/
-pw useradd -n _portzap \
+$ git clone https://github.com/0x1eef/portzap.git
+$ cd portzap
+# cp -R bin /usr/local/
+# cp -R libexec /usr/local/
+# pw useradd -n _portzap \
-c "portzap utility user" \
-m \
-s /sbin/nologin
-pw groupmod -n _portzap -m
+# pw groupmod -n _portzap -m
```
## Sources
-* [Source code (git.hardenedbsd.org)](https://git.hardenedbsd.org/0x1eef/portzap)
-* [Source code (GitHub)](https://github.com/0x1eef/portzap)
-* [Source code (GitLab)](https://gitlab.com/0x1eef/portzap)
+* [GitHub](https://github.com/0x1eef/portzap)
+* [GitLab](https://gitlab.com/0x1eef/portzap)
+* [git.hardenedbsd.org](https://git.hardenedbsd.org/0x1eef/portzap)
## License