diff options
| author | 2025-11-15 00:00:00 +0000 | |
|---|---|---|
| committer | 2025-11-15 00:00:00 +0000 | |
| commit | 25a95511209f461ff90b5ea5c82439c30f2471ef (patch) | |
| tree | f424a7ff73767d0688252aa4ba5eb7f0edaf2326 /README.md | |
| parent | Use Lindenii Forge (diff) | |
| signature | ||
Another README update
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 16 insertions, 6 deletions
@@ -5,25 +5,25 @@ Furgit is a fast Git library in pure Go. +## Project status + 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. When we do have tagged releases, we will likely follow [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html). +## History + 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. +## Goals and current features + 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. -## Features - -Currently, furgit is very basic; it supports reading and writing loose objects -and reading from packfiles. There is some infrastructure for writing packfiles -in the tests but they need to be refactored. - We intend for repository objects to be freely usable across goroutines, which may enable long-running applications such as forges to keep a pool of recently used repos (including their `.idx` and `.pack` cache) for rapid access. @@ -34,6 +34,16 @@ developing what forges like [Villosa](https://codeberg.org/lindenii/villosa) and a look at what other usages (such as writing Git clients, IDE integration, etc) would need. +Furgit has no dependencies outside the standard library. In the future, +packages from `golang.org/x` may be included. It is unlikely that other +dependencies will be introduced. + +Currently, furgit is very basic; it supports reading and writing loose objects +and reading from packfiles. There is some infrastructure for writing packfiles +in the tests but they need to be refactored. + +## Environment requirements + We currently do not intend to support flexible storage backends such as [storers in go-git](https://pkg.go.dev/github.com/go-git/go-git/v5/plumbing/storer); a standard UNIX-like filesystem with |
