lib/libgfold/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
```