diff --git a/README.md b/README.md new file mode 100644 index 0000000..643ae41 --- /dev/null +++ b/README.md @@ -0,0 +1,9 @@ +A small library that examines the internal files of a git repo. + +It can handle: +- objects, stored loose or in packs (including ref and offset deltas) +- the staging index +- refs +- reflogs + +Compile the `cli` project (a CLI wrapper around the main library), then run it with `--help` to get help.