diff options
Diffstat (limited to 'cgithub/README.md')
| -rw-r--r-- | cgithub/README.md | 26 |
1 files changed, 23 insertions, 3 deletions
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.  +## 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: |