From 363e8db444d9aade0fcca2bd3171653b7dab01d8 Mon Sep 17 00:00:00 2001
From: Joe Mou <dev@mou.fo>
Date: Fri, 18 Sep 2026 07:42:53 +0100
Subject: Run cgithub locally on elmo

---
 cgithub/README.md | 26 +++++++++++++++++++++++---
 1 file changed, 23 insertions(+), 3 deletions(-)

(limited to 'cgithub/README.md')

diff --git a/cgithub/README.md b/cgithub/README.md
index 45c94cf..135e5ce 100644
--- a/cgithub/README.md
+++ b/cgithub/README.md
@@ -1,10 +1,30 @@
 cgithub is a lightweight GitHub alternative frontend. It has no bloated
-JavaScript and doesn't require API keys. It runs on Cloudflare Workers; to use
-it, deploy your own instance then replace `github.com` in your URL with your
-domain.
+JavaScript and doesn't require API keys. It can run on Cloudflare Workers or
+as a local Node server; to use it, run your own instance then replace
+`github.com` in your URL with your domain.
 
 ![Screenshot of cgithub repository page.](docs/screenshot.png)
 
+## Development
+
+Run the Cloudflare version locally with:
+
+```sh
+pnpm run dev
+```
+
+Run the Node server locally with:
+
+```sh
+pnpm run dev:local
+```
+
+To deploy the Worker to Cloudflare:
+
+```sh
+pnpm run deploy
+```
+
 ## Features
 
 Implemented:
-- 
cgit v1.3.1