docs: add README.md
trickyni trickyniv56@gmail.com
Sun, 24 May 2026 10:01:38 +0300
1 files changed,
16 insertions(+),
1 deletions(-)
jump to
M
README.md
→
README.md
@@ -1,3 +1,18 @@
# Kushiyaki -UNDER CONSTRUCTION +## Installation + +1. Bun add kushiyaki +2. Bun add hastx +3. curl <https://codeberg.org/trickyni/kushiyaki/raw/branch/main/bunfig.toml> > bunfig.toml +4. bunx kushiyaki + +## usage + +create `input` folder in the project's root directory, and populate it with markdown files and assets +use `bunx kushiyaki` to process the files into an `out` folder + +### local server + +`bunx kushiyaki run dev` to deploy a local version of the website using [caddy](https://caddyserver.com/) +use `caddy stop` to remove the server (will be changed to an autoreload)