From 075ae78c8b189eda9c49a2e9e7dbe5bf2a8e2909 Mon Sep 17 00:00:00 2001 From: poyo Date: Wed, 15 Jul 2026 23:45:37 +0200 Subject: [PATCH] explanation of what farga is + contribution guide --- README.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 200da00..d808a70 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # Farga -DIY Git forge. Small and cool. (because your computer won't overheat (if you don't clean it then it's YOUR fault)) +Farga is a DIY Git forge. It's being developed by ONE person. Keep that in mind. + +- Easily self-hostable. Uses Sqlite (goated) and stores all repos on-disk. +- It ships almost no Javascript to the frontend. All features work without Javascript. +- It's small and cool. (Your computer won't overheat because of it) +- It has a Hackatime integration. Show how much time you've spent coding, on the repo page itself! ## TODO: - [ ] Auth: @@ -29,7 +34,10 @@ DIY Git forge. Small and cool. (because your computer won't overheat (if you don - [ ] "Time spent" badge on repos. - [x] Link Hackatime. -## how to run: +## Contributing +I welcome contributions, as long as they're not AI slop or massive, I'm just unable to review them. + +## How to run: First of all, copy `example.env`. If you're willing to let your users login with Hackatime, go to Hackatime's [OAuth2 Applications](https://hackatime.hackclub.com/oauth/applications) page, create a new OAuth app and put the secret and app ID on the .env -- 2.54.0