[add] split wanted files vs wanted metadata for ko apis, [add] documentation

README.md

@@ -1,14 +1,14 @@
 # Book Manager
 
 <p align="center">
-    <a href="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/login.png">
-        <img src="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/login.png" width="30%">
+    <a href="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/web_login.png">
+        <img src="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/web_login.png" width="30%">
     </a>
-    <a href="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/home.png">
-        <img src="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/home.png" width="30%">
+    <a href="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/web_home.png">
+        <img src="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/web_home.png" width="30%">
     </a>
-    <a href="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/documents.png">
-        <img src="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/documents.png" width="30%">
+    <a href="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/web_documents.png">
+        <img src="https://gitea.va.reichard.io/evan/BookManager/raw/branch/master/screenshots/web_documents.png" width="30%">
     </a>
 </p>
 
@@ -25,10 +25,29 @@ In additional to the compatible KOSync API's, we add:
 - Additional APIs to automatically upload reading statistics
 - Automatically upload documents to the server (can download in the "Documents" view)
 - Automatic book cover metadata scraping (Thanks [OpenLibrary](https://openlibrary.org/))
+- No JavaScript! All information is rendered server side.
+
+# Server
+
+## Configuration
+
+| Environment Variable | Default Value | Description                                                          |
+| -------------------- | ------------- | -------------------------------------------------------------------- |
+| DATABASE_TYPE        | SQLite        | Currently only "SQLite" is supported                                 |
+| DATABASE_NAME        | bbank         | The database name, or in SQLite's case, the filename                 |
+| DATABASE_PASSWORD    | <EMPTY>       | Currently not used. Placeholder for potential alternative DB support |
+| CONFIG_PATH          | /config       | Directory where to store SQLite's DB                                 |
+| DATA_PATH            | /data         | Directory where to store the documents and cover metadata            |
+| LISTEN_PORT          | 8585          | Port the server listens at                                           |
+| REGISTRATION_ENABLED | false         | Whether to allow registration (applies to both WebApp & KOSync API)  |
+
+# Client (KOReader Plugin)
+
+See documentation in the `client` subfolder: [SyncNinja](https://gitea.va.reichard.io/evan/BookManager/src/branch/master/client/)
 
 # Development
 
-SQLC Generation:
+SQLC Generation (v1.21.0):
 
 ```
 go install github.com/sqlc-dev/sqlc/cmd/sqlc@latest
@@ -41,6 +60,28 @@ Run Development:
 CONFIG_PATH=./data DATA_PATH=./data go run cmd/main.go serve
 ```
 
+# Building
+
+The `Dockerfile` and `Makefile` contain the build information:
+
+```
+# Build Local Docker Image
+make docker_build_local
+
+# Push Latest
+make docker_build_release_latest
+```
+
+If manually building, you must enable CGO:
+
+```
+# Download Dependencies
+go mod download
+
+# Compile (Binary `./bookmanager`)
+CGO_ENABLED=1 CGO_CFLAGS="-D_LARGEFILE64_SOURCE" go build -o /bookmanager cmd/main.go
+```
+
 ## Notes
 
 - Icons: https://www.svgrepo.com/collection/solar-bold-icons