From c2ef25c9cf40c9e72a1af0e4a53fb490b759f639 Mon Sep 17 00:00:00 2001
From: kitsunecafe <10284516+kitsunecafe@users.noreply.github.com>
Date: Thu, 22 Feb 2024 01:39:05 -0500
Subject: [PATCH] update readme

---
 README.md | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index c04d72e..26db1af 100644
--- a/README.md
+++ b/README.md
@@ -3,12 +3,14 @@
 this is a wip overhaul for my static site generator, roxy. it technically works but it's very rough around the edges.
 
 # Installation
-it's not a published crate yet so you have to compile it for now, sorry
+```rs
+cargo install roxy_cli
+```
 
 # Usage
 
 ```bash
-roxy [INPUT] [OUTPUT]
+roxy_cli [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`).