aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Runxi Yu2026-05-24 08:39:51 +0000
committerGravatar Runxi Yu2026-05-24 08:40:32 +0000
commit5197944c268811759f16b8fe2f6dabe756d566a2 (patch)
treea660c8f5edec8a4574948207b92b1dca24d2fcbc /README.md
parentREADME: Use the next branch's build status (diff)
signatureNo signature
README, CONTRIBUTING: Simplify
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 5 insertions, 16 deletions
diff --git a/README.md b/README.md
index d5498db9..b417d0ef 100644
--- a/README.md
+++ b/README.md
@@ -3,24 +3,13 @@
[![builds.sr.ht status](https://builds.sr.ht/~runxiyu/furgit/commits/next.svg)](https://builds.sr.ht/~runxiyu/furgit/commits/next)
[![Go Reference](https://pkg.go.dev/badge/codeberg.org/lindenii/furgit.svg)](https://pkg.go.dev/codeberg.org/lindenii/furgit)
-Furgit is a low‐level Git library in Go.
-
-Please refer to the API reference.
+A low‐level Git plumbing library in Go.
## Status
-* Years or decades away from stable
-* Absolutely no guarantees
-* Do not use in production
-* Mature alternative: [go-git](https://github.com/go-git/go-git)
-* Will use [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html) starting at 1.0.0
-
-## Goals
-
-* General‐purpose Git plumbing library for UNIX‐like systems
-* Aim for extremely clear and modular architecture
-* Then aim for high performance
-* Expect familiarity with Git internals
+* This `next` branch is work in progress.
+* Early development, not suitable for production.
+* Mature alternative: [go-git](https://github.com/go-git/go-git).
## Community
@@ -29,7 +18,7 @@ Please refer to the API reference.
* [#lindenii](https://web.libera.chat/#lindenii)
on [Libera.Chat](https://libera.chat)
-See `CONTRIBUTING.md` for bug reports and patch submissions.
+See also `CONTRIBUTING.md`.
## Acknowledgements