prepare webdog for first release

This commit is contained in:
zyl 2025-01-15 01:38:53 -08:00
parent 727e68c817
commit 3d20c3721c
Signed by: zyl
SSH key fingerprint: SHA256:uxxbSXbdroP/OnKBGnEDk5q7EKB2razvstC/KmzdXXs
2 changed files with 24 additions and 1 deletions

View file

@ -1,6 +1,11 @@
[package] [package]
description = "static site generator fit for a dog"
edition = "2021" edition = "2021"
homepage = "https://webdog.zyl.gay"
license = "AGPLv2"
name = "webdog" name = "webdog"
readme = "README.md"
repository = "https://github.com/zyllian/webdog"
version = "0.1.0" version = "0.1.0"
[dependencies] [dependencies]

View file

@ -1,3 +1,21 @@
# webdog # 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"
```