diff --git a/README.md b/README.md index 25a7714..5bd991d 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,32 @@ -## About +

+ portzap +

-portzap is a simple bourne shell script that takes care of keeping up to -date with the [HardenedBSD](https://hardenedbsd.org) ports collection. +portzap is a utility for staying up to date with the +[HardenedBSD ports tree](https://hardenedbsd.org). +The utility stores a transient copy of the ports tree in `/home/_portzap/ports/`. +The transient copy can be created, and updated by an unprivileged user account +who is a member of the `_portzap` group. The transient copy can then be installed +into the `/usr/ports` directory by root. -The -[HardenedBSD ports collection](https://git.hardenedbsd.org/hardenedbsd/ports.git) -is maintained as a git repository, and portzap allows the repository to be cloned -(and updated) using a regular user account. The unpacking of the repository to -`/usr/ports` is also supported but must be performed by root. -## Usage - -* **portzap init**
- This command should be run as root.
- The command creates the `_portzap` user / group, and the directory `/home/_portzap`. +

+ Usage +

* **portzap clone**
- This command should be run by a user account that is a member of the `_portzap` group.
- The command clones HardenedBSD's ports collection into `/home/_portzap/ports`. + This command clones HardenedBSD's ports tree into `/home/_portzap/ports`. * **portzap pull**
- This command should be run by a user account that is a member of the `_portzap` group.
- The command updates an existing repository previously cloned with `portzap clone`. + This command pulls updates into `/home/_portzap/ports`. * **portzap install**
This command should be run as root.
The command installs `/home/_portzap/ports` into `/usr/ports`. -## Sources +

+ Sources +

* [Source code (git.hardenedbsd.org)](https://git.hardenedbsd.org/0x1eef/portzap) * [Source code (GitHub)](https://github.com/0x1eef/portzap)