search

kinnison / git-testament

Rust library for creating a commit testament at compile time
BSD 3-Clause "New" or "Revised" License
47 stars 10 forks source link

Example? #31

Closed hydrargyrum closed 9 months ago

hydrargyrum commented 9 months ago

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

kinnison commented 9 months ago

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?