From 005af71c5707da8db0374154412d77a5ec524a44 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rodolphe=20Br=C3=A9ard?= Date: Fri, 25 Aug 2023 11:37:24 +0200 Subject: [PATCH] Add installation instructions --- README.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/README.md b/README.md index 4a6e571..20d606b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ Web application that can be used to generate new sub-addresses as defined in the [Sub-Address KEy (SAKE) filter](https://github.com/breard-r/opensmtpd-filter-sake). +## Install + +Download the build from [the latest released version](https://github.com/breard-r/sake-app/releases). Extract the archive and configure your web server to serve those files. + +That's it. The final build is plain HTML/CSS/JS with a few assets, therefore there is no back-end to configure. + +Alternatively, on ArchLinux you can install the [sake-app](https://aur.archlinux.org/packages/sake-app) package from the AUR. You will find the files in the `/usr/share/webapps/sake-app` directory. + + ## Project Setup ```sh