aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Runxi Yu2025-11-15 00:00:00 +0000
committerGravatar Runxi Yu2025-11-15 00:00:00 +0000
commit0f4b66b0cbec0977efc9e8f3dd74bd8ae1bef1d0 (patch)
treeb5afafa6feaa0e648f3795cb24a9f570e130be31
parentFix DCO link (diff)
signature
State lineage better
-rw-r--r--README.md7
1 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9aa2491a..ddcc43c1 100644
--- a/README.md
+++ b/README.md
@@ -3,13 +3,16 @@
[![builds.sr.ht status](https://builds.sr.ht/~runxiyu/furgit.svg)](https://builds.sr.ht/~runxiyu/furgit?)
[![Go Reference](https://pkg.go.dev/badge/git.sr.ht/~runxiyu/furgit.svg)](https://pkg.go.dev/git.sr.ht/~runxiyu/furgit)
-Furgit is a fast implementation of Git in pure Go, extracted from
-[an internal package of Lindenii Villosa](https://codeberg.org/lindenii/villosa/src/branch/master/villosad/internal/common/git).
+Furgit is a fast Git library in pure Go.
Furgit is in initial development, does not have tagged releases yet, and we can
guarantee that the API will break every now and then. Do not use in
production.
+Furgit's lineage is from [Villosa](https://codeberg.org/lindenii/villosa), a
+new, work-in-progress software development forge. It started as an internal
+package inside Villosa, and was later extracted into a standalone module.
+
We do not focus on command-line utilities; in particular, Furgit does not
intend to replace [upstream git](https://git-scm.com). It is intended to be
used as a library.