From 8fbc00847e764db21a25c5be5500e09782e4a603 Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Wed, 27 May 2026 06:07:55 +0000 Subject: README: Use next's --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a61ccef0..2f2175b6 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,16 @@ [![builds.sr.ht status](https://builds.sr.ht/~runxiyu/furgit/commits/master.svg)](https://builds.sr.ht/~runxiyu/furgit/commits/master) [![Go Reference](https://pkg.go.dev/badge/codeberg.org/lindenii/furgit.svg)](https://pkg.go.dev/codeberg.org/lindenii/furgit) -A low‐level Git library in Go. +A low‐level Git plumbing library in Go. + +A refactor is pending on the `next` branch. ## Status -* **A refactor is pending on the `next` branch.** -* Early development, not suitable for production. -* A mature alternative is [go-git](https://github.com/go-git/go-git). +**You should *not* use furgit.** + +Furgit is an unfinished research project, +and has breaking API changes every few days. ## Community @@ -22,9 +25,9 @@ See also `CONTRIBUTING.md`. ## Acknowledgements -Partly inspired by [upstream Git](https://git-scm.com), +Partly inspired by [upstream git](https://git-scm.com), OpenBSD's [Game of Trees](https://gameoftrees.org), and -[9front Git](https://git.9front.org/plan9front/9front/HEAD/sys/src/cmd/git/f.html). +[9front git](https://git.9front.org/plan9front/9front/HEAD/sys/src/cmd/git/f.html). ## License @@ -47,7 +50,7 @@ version for this Program. * [Codeberg](https://codeberg.org/lindenii/furgit) * [SourceHut mirror](https://git.sr.ht/~runxiyu/furgit) * [hjgit mirror](https://hjgit.org/runxiyu/furgit/HEAD/info.html) -* [tangled mirror](https://tangled.org/@runxiyu.tngl.sh/furgit) -* [GitHub mirror](https://github.com/runxiyu/furgit) * [git.runxiyu.org mirror](https://git.runxiyu.org/furgit.git//) * [cgit.space mirror](https://cgit.space/~runxiyu/furgit.git/) +* [tangled mirror](https://tangled.org/@runxiyu.tngl.sh/furgit) +* [GitHub mirror](https://github.com/runxiyu/furgit) -- cgit v1.3.1-10-gc9f91