aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorWynn Wolf Arbor2020-05-31 19:35:06 +0200
committerWynn Wolf Arbor2020-05-31 19:35:06 +0200
commit26e9dd45937136187b0a1b6bb75c9f7526b37ba7 (patch)
treeb12174b939ec0997beb31a776a4f635fcc76e839 /README.md
parent31b95084abb39fbb0814ba86aec442782aef112f (diff)
downloadskein-26e9dd45937136187b0a1b6bb75c9f7526b37ba7.tar.gz
README: Reword introduction and include links to relevant resources
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index ffa0751..1748611 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,12 @@
# skein - secure cgit hosting with slowcgi(8)
-This is a small collection of utilities needed for managing a secure and
-extensible deployment of cgit using OpenBSD's slowcgi(8).
+skein is a [framework](skein.7) for managing a secure and extensible deployment
+of [cgit](https://git.zx2c4.com/cgit/about/) using OpenBSD's slowcgi(8). It
+also includes a few small helper utilities.
## Utilities
-- skein-infra - set up skein's cgit chroot infrastructure
+- [skein-infra(8)](skein-infra.8) - set up skein's cgit chroot infrastructure
- cgit-about-filter - a C implementation of a simple about-filter for
- cgit using mandoc(1) and lowdown(1).
+ cgit using [mandoc(1)](https://mandoc.bsd.lv/) and
+ [lowdown(1)](https://kristaps.bsd.lv/lowdown/).