From 3d20c3721cf2f6835ba8c334527cb8db6314975f Mon Sep 17 00:00:00 2001
From: zyl <z@zyl.gay>
Date: Wed, 15 Jan 2025 01:38:53 -0800
Subject: [PATCH] prepare webdog for first release

---
 Cargo.toml |  5 +++++
 README.md  | 20 +++++++++++++++++++-
 2 files changed, 24 insertions(+), 1 deletion(-)

diff --git a/Cargo.toml b/Cargo.toml
index e178095..b84dee0 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,6 +1,11 @@
 [package]
+description = "static site generator fit for a dog"
 edition = "2021"
+homepage = "https://webdog.zyl.gay"
+license = "AGPLv2"
 name = "webdog"
+readme = "README.md"
+repository = "https://github.com/zyllian/webdog"
 version = "0.1.0"
 
 [dependencies]
diff --git a/README.md b/README.md
index 8a9584c..d083a2d 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,21 @@
 # webdog
 
-Source for webdog, the static site generator fit for a dog. See our website at https://webdog.zyl.gay for more details.
+webdog, the static site generator fit for a dog :3
+
+```sh
+cargo install webdog
+```
+
+after installing, you can create your first site:
+
+```sh
+webdog create https://example.com "My First Site!" --site my-site
+cd my-site
+webdog serve # your site is now running at http://127.0.0.1:8080 🥳
+```
+
+from there, you can start editing your site and adding pages or [more advanced things](https://webdog.zyl.gay/docs/)
+
+```sh
+webdog page new my-first-page "My First Page"
+```