Skip to content

Commit

Permalink
Move usage as a library section before troubleshooting
Browse files Browse the repository at this point in the history
Signed-off-by: Nick Gerace <nickagerace@gmail.com>
  • Loading branch information
nickgerace committed Jul 7, 2023
1 parent 9ba9171 commit 6c700c6
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,13 @@ Please [file an issue](https://github.com/nickgerace/gfold/issues/new)!
`gfold` is intended to be ran on _any_ tier one Rust 🦀 target.
Please [file an issue](https://github.com/nickgerace/gfold/issues) if your platform is unsupported.

## 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)

## Troubleshooting and Known Issues

If you encounter unexpected behavior or a bug and would like to see more details, please run `gfold` with the following
Expand Down Expand Up @@ -235,13 +242,6 @@ 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.
Expand Down

0 comments on commit 6c700c6

Please sign in to comment.