First round of USAGE docs.

Also, have the Result iterator auto-rewind when complete.

FossilOrigin-Name: d10c2e7dd8dd447cc33f1cfb6fbbd94946f56e8da912e1619673338d9c8a968d
This commit is contained in:
mahlon 2025-03-31 19:35:15 +00:00
parent 6f6ab2f85a
commit 6197b8ab3f
10 changed files with 698 additions and 15 deletions

View file

@ -39,18 +39,14 @@ For more information about Kuzu itself, see its
$ nimble install kuzu
The current version of this library is built for Kuzu v0.8.2.
## Usage
See the [Usage documentation](USAGE.md).
> [!TODO]- Human readable usage docs!
>
> ... The nim generated source isn't great when pulling in
> the C wrapper auto-gen stuff.
>
> If you're here and reading this before I have proper docs written, see the
> tests/ for some working examples.
You can also find a bunch of working examples in the tests.
## Contributing