summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Gerace <nickagerace@gmail.com>2023-07-07 11:17:18 -0400
committerNick Gerace <nickagerace@gmail.com>2023-07-07 11:17:18 -0400
commit9ba917158339a4c070f079fdd72a5180b11c799d (patch)
tree2cf8eccfa0ff8e937591cbe5f334893a5a315b11
parent76d9d6d0c728052af68a3354b4fae4d5a91c751b (diff)
downloadgfold-9ba917158339a4c070f079fdd72a5180b11c799d.zip
Add usage as a library section to README
Signed-off-by: Nick Gerace <nickagerace@gmail.com>
-rw-r--r--README.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.md b/README.md
index 04775f3..58d15f8 100644
--- a/README.md
+++ b/README.md
@@ -235,6 +235,13 @@ If you are seeing `unsupported extension name extensions.worktreeconfig` or simi
This repository's tracking issue is [#205](https://github.com/nickgerace/gfold/issues/205).
+## Usage as a Library
+
+There are two ways to use `gfold` as a "library".
+
+1) Use the [`libgfold`](./lib/libgfold/README.md) crate that powers `gfold`
+1) Consume valid JSON results from `gfold -d json` (not a library, but useful for non-Rust applications)
+
## Community
For more information and thanks to contributors, users, and the "community" at large, please refer to the **[THANKS](./docs/THANKS.md)** file.