New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Example? #31

Closed

hydrargyrum opened this issue Jan 16, 2024 · 1 comment · Fixed by #32

Contributor

hydrargyrum commented Jan 16, 2024

The README doesn't give an example of the output. Is it a hash? A description? In what format?

Owner

kinnison commented Jan 17, 2024

Hi, this is a good point I guess I need to direct the reader of the README to the rustdoc a little more.

If you use the rustdoc then you get led to the GitTestament docs which explain the data structure.

Could you come up with a PR for the README which makes this clearer for new users?

hydrargyrum mentioned this issue

README: give an example of output + add docs link #32

Merged

kinnison closed this as completed in #32

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment