From bcc18a83f9b76f0b4be39ecce878274644c44108 Mon Sep 17 00:00:00 2001
From: Evie Viau <evie@eviee.gay>
Date: Sat, 4 Feb 2023 23:46:54 -0800
Subject: [PATCH] Add container instructions

---
 Cargo.lock | 34 +++++++++++++++++-----------------
 Cargo.toml |  5 +++--
 Dockerfile |  4 ++--
 README.md  | 14 ++++++++++++++
 4 files changed, 36 insertions(+), 21 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index 03d9cee..6acf291 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -1160,6 +1160,23 @@ dependencies = [
  "log",
 ]
 
+[[package]]
+name = "kyanite"
+version = "0.1.0"
+dependencies = [
+ "askama",
+ "askama_axum",
+ "axum",
+ "dotenvy",
+ "log",
+ "migration",
+ "sea-orm 0.11.0-rc.1",
+ "serde",
+ "serde_json",
+ "tokio",
+ "tracing-subscriber",
+]
+
 [[package]]
 name = "lazy_static"
 version = "1.4.0"
@@ -1455,23 +1472,6 @@ version = "2.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "478c572c3d73181ff3c2539045f6eb99e5491218eae919370993b890cdbdd98e"
 
-[[package]]
-name = "personal-site"
-version = "0.1.0"
-dependencies = [
- "askama",
- "askama_axum",
- "axum",
- "dotenvy",
- "log",
- "migration",
- "sea-orm 0.11.0-rc.1",
- "serde",
- "serde_json",
- "tokio",
- "tracing-subscriber",
-]
-
 [[package]]
 name = "pest"
 version = "2.5.4"
diff --git a/Cargo.toml b/Cargo.toml
index a12e8b2..8cbf35a 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,9 +1,10 @@
 [package]
-name = "personal-site"
+name = "kyanite"
 version = "0.1.0"
 edition = "2021"
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+repository = "https://git.gaycatgirl.sex/evie/kyanite"
+license = "Apache-2.0"
 
 [dependencies]
 
diff --git a/Dockerfile b/Dockerfile
index f3952db..77aa59b 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -6,6 +6,6 @@ RUN cargo build --release
 
 FROM debian:stable-slim
 
-COPY --from=build ./target/release/personal-site .
+COPY --from=build ./target/release/kyanite .
 
-CMD ["./personal-site"]
\ No newline at end of file
+CMD ["./kyanite"]
\ No newline at end of file
diff --git a/README.md b/README.md
index 7061982..b6f43ec 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,20 @@ Rusty CMS/Blogging engine thingamabob™
 
 > ⚠️ Kyanite is still **very** early in development and may **not** be ready for your uses just yet! Containers are also on a rolling release.
 
+## Usage
+
+### Container
+
+It's pretty simple as Kyanite only relies on PostgreSQL, no volumes or mounts are needed.
+Just use your favourite OCI container software and pull `git.gaycatgirl.sex/evie/kyanite:latest`.
+
+```
+podman pull git.gaycatgirl.sex/evie/kyanite:latest
+podman run -d --name kyanite -p 3621:3621 -e DATABASE_URL=postgres://xxx:xxx@xxx:xxx/xxx git.gaycatgirl.sex/evie/kyanite:latest
+```
+
+### Enviroment Variables
+
 |  **ENV VAR** |                           **DESCRIPTION**                           | **DEFAULT** |
 |:------------:|:-------------------------------------------------------------------:|:-----------:|
 | DATABASE_URL | Required. Specifies the connection URl for the PostgreSQL database. | N/A         |