aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 15 insertions, 11 deletions
diff --git a/README.md b/README.md
index a61ccef0..06fa0507 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,19 @@
# Furgit
-[![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)
+[![builds.sr.ht status](https://builds.sr.ht/~runxiyu/furgit/commits/legacy.svg)](https://builds.sr.ht/~runxiyu/furgit/commits/legacy)
+[![Go Reference](https://pkg.go.dev/badge/lindenii.org/go/furgit.svg)](https://pkg.go.dev/lindenii.org/go/furgit)
-A low‐level Git library in Go.
+A low‐level Git plumbing library in Go.
+
+This `legacy` branch will probably be deprecated sometime.
+See `main`.
## 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 +26,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
@@ -44,10 +48,10 @@ version for this Program.
## Repos and mirrors
-* [Codeberg](https://codeberg.org/lindenii/furgit)
+* [git.runxiyu.org](https://git.runxiyu.org/furgit.git//)
+* [Codeberg mirror](https://codeberg.org/lindenii/furgit)
* [SourceHut mirror](https://git.sr.ht/~runxiyu/furgit)
* [hjgit mirror](https://hjgit.org/runxiyu/furgit/HEAD/info.html)
+* [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)
-* [git.runxiyu.org mirror](https://git.runxiyu.org/furgit.git//)
-* [cgit.space mirror](https://cgit.space/~runxiyu/furgit.git/)