From 92895f4e098357a547d72c33ec1dc995853b6aec Mon Sep 17 00:00:00 2001 From: Aaron Bieber Date: Sat, 23 Jan 2021 09:11:06 -0700 Subject: [PATCH] update readme a bit --- README.md | 30 ++++-------------------------- 1 file changed, 4 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 43ad7a9..1e68e65 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,9 @@ # gavin -[![builds.sr.ht status](https://builds.sr.ht/~qbit/gavin.svg)](https://builds.sr.ht/~qbit/gavin?) +*gavin* is a self contained instance of [Organice](https://github.com/200ok-ch/organice). -Simple utility to serve password protected, HTTPS'd WebDAV server and -[Organice](https://github.com/200ok-ch/organice) instance. +It combines a WebDAV server and the Organice assets into a single binary that +can be run from virtually everywhere. -## Installation +`gavin` can be used as a standalone webserver or placed behind a reverse proxy. -``` -go git -u suah.dev/gavin -``` - -## Example usage - -`gavin` was built as a simple WebDAV server specifically to run -[organice](https://github.com/200ok-ch/organice). Here is an example showing how -to host organice via WebDAV. - -| Flag | Value | Description | -|-----------|---------------------|-----------------------------------------------------------------------------------------| -| `-davdir` | /tmp/org | The directory we have our .org files in. | -| `-htpass` | /tmp/.htpasswd | Standard `htpasswd` file generated with `htpasswd`. Currently only bcrypt is supported. | - -``` -gavin -davdir /tmp/org -htpass /tmp/.htpasswd -``` - -Now you can open your browser to -[http://localhost:8080/](http://localhost:8080/), sign in using the credentials -in the `.htpasswd` file, and org away!