upd readme

tariel-x · Jan 14, 2021 · 8a1a49f · 8a1a49f
1 parent fedbe16
commit 8a1a49f
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 106 deletions.
diff --git a/README.md b/README.md
@@ -7,11 +7,25 @@ Scan is the frontend for SANE built with golang and svelte.
 Features:
 
 - List connected scanners.
+- Configure the selected scanner.
 - Scan image from the selected scanner.
 
 ## Build & run
 
+Install libsane-dev, e.g. for Ubuntu:
+
+```shell
+sudo apt install -y libsane-dev
+```
+
+Build and run service:
+
 ```bash
 go build -o scan ./cmd/scan
 LISTEN=0.0.0.0:8085 ./scan
-```
+```
+
+## Environment variables
+
+- `DEBUG` enables debug log level and text format for logs.
+- `LISTEN` is the interface to listen for.
diff --git a/web/README.md b/web/README.md