From 9ba917158339a4c070f079fdd72a5180b11c799d Mon Sep 17 00:00:00 2001 From: Nick Gerace Date: Fri, 7 Jul 2023 11:17:18 -0400 Subject: Add usage as a library section to README Signed-off-by: Nick Gerace --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) 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. -- cgit v1.2.3