From 5d89a8aebe3b11800206822b0a965404631e7046 Mon Sep 17 00:00:00 2001
From: KitsuneCafe <10284516+kitsunecafe@users.noreply.github.com>
Date: Sun, 4 Feb 2024 06:45:43 -0500
Subject: [PATCH] read it

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index 45ef242..01ee79d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,21 @@
 # Roxy
+
 this is a wip overhaul for my static site generator, roxy. it technically works but it's very rough around the edges.
 
+# Usage
+
+```bash
+roxy [INPUT] [OUTPUT]
+```
+
+Roxy will read each file from `INPUT` for valid files. It will look for `toml` for data and `md`, `html`, or `tera` for layout an content files. `toml` data is loaded into an object and given to content files (which can be used as variables with Tera placeholders). The content files will be processed first as Markdown, then as a Tera template. The output of this process will write to `OUTPUT`, preserving the original path (relative to `INPUT`).
+
+# Configuration
+
+Currently, Roxy only has two configuration keys
+
+```toml
+theme = "base16-ocean.dark" # the name of the theme for syntax highlighting
+themes = ["./themes/base16-ocean.dark.tmTheme"]
+```
+