From 5197944c268811759f16b8fe2f6dabe756d566a2 Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Sun, 24 May 2026 08:39:51 +0000 Subject: README, CONTRIBUTING: Simplify --- README.md | 21 +++++---------------- 1 file changed, 5 insertions(+), 16 deletions(-) (limited to 'README.md') 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 -- cgit v1.3.1-10-gc9f91