diff --git a/README.md b/README.md index 75664cc..23c0546 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,16 @@ # Waffle Mole -A small gopher server for POSIX systems, written in C99. +A small gopher server for POSIX systems, written in C99. Drops +priviledges with `pledge()` and `unveil()` on OpenBSD. -To build: `make` +## Building + +You'll need: +- A C99 compiler +- POSIX-compatible make + +Run `make` or `make waffle-mole`. + +## Limitations + +Only IPv6 is supported currently.