diff --git a/README.md b/README.md index e252505..c83de4f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,38 @@ +# Duckquill +[![status-badge](https://ci.codeberg.org/api/badges/12428/status.svg)](https://ci.codeberg.org/repos/12428) + +## Usage + +### 🧪️ Test pages + +- [Demo page](https://daudix-ufo.codeberg.page/duckquill/demo/) +- [Cake Party!](https://daudix-ufo.codeberg.page/duckquill/demo-page/) +- [ActivityPub/​Fediverse comments demo](https://daudix-ufo.codeberg.page/duckquill/comments/) + +### 🏗️ Build static files + +```shell +./local.sh build +``` + +### ⏱️ Watch static files and serve + +```shell +./local.sh serve +``` + +_Building guide were shamelessly taken from [here](https://talk.jekyllrb.com/t/local-testing-of-existing-github-jekyll-site/7459/4)_ + +_Initial script (`local.sh`) were taken from [here](https://kuros.in/docker/docker-jekyll-container-to-serve-locally)_ + +### 🏷️ Rename posts to web-friendly format + +```shell +./rename.sh posts +``` + +## ❤️ Special thanks - Jakub Steiner for an awesome [OS Component Website](https://jimmac.github.io/os-component-website) that are used as a base - Cassidy James for and awesome [Mastodon-powered comments](https://cassidyjames.com/blog/fediverse-blog-comments-mastodon)