aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..0673ff0d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Furgit
+
+[![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).
+
+## Development
+
+- [Main SourceHut repository](https://git.sr.ht/~runxiyu/furgit)
+ and [public inbox](https://lists.sr.ht/~runxiyu/public-inbox)
+ for [patches](https://git-send-email.io/) and discussions
+- [GitHub mirror](https://github.com/runxiyu/furgit)
+ (issues and PRs are welcome)