summaryrefslogtreecommitdiff
path: root/lib/libgfold/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'lib/libgfold/README.md')
-rw-r--r--lib/libgfold/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/lib/libgfold/README.md b/lib/libgfold/README.md
new file mode 100644
index 0000000..320f912
--- /dev/null
+++ b/lib/libgfold/README.md
@@ -0,0 +1,19 @@
+# libgfold
+
+[![crates.io version](https://img.shields.io/crates/v/libgfold?style=flat-square&logo=rust&color=orange)](https://crates.io/crates/libgfold)
+[![license](https://img.shields.io/github/license/nickgerace/gfold?style=flat-square&logo=apache&color=silver)](../../LICENSE)
+[![build status](https://img.shields.io/github/actions/workflow/status/nickgerace/gfold/ci.yml?branch=main&style=flat-square&logo=github&logoColor=white)](https://github.com/nickgerace/gfold/actions)
+
+**libgfold** provides the ability to find a minimal set of user-relevant information for Git repositories on a local
+filesystem.
+This library powers [**gfold**](https://github.com/nickgerace/gfold).
+
+## Documentation
+
+<!-- You can find the docs on [docs.rs](https://docs.rs/libgfold), but they are a work in progress. -->
+
+View documentation locally with the following command.
+
+```shell
+cargo doc -p libgfold --no-deps --open
+``` \ No newline at end of file