commit e0343a233cf766f7a04ff6dfa69d39367d90029b parent f9623b0a9797e21e95e61784e5091f69cd94b991 Author: brookjeynes <me@brookjeynes.dev> Date: Thu, 18 Jun 2026 12:26:23 +1000 docs: add readme and examples Signed-off-by: brookjeynes <me@brookjeynes.dev> Diffstat:
| A | README | | | 38 | ++++++++++++++++++++++++++++++++++++++ |
1 file changed, 38 insertions(+), 0 deletions(-)
diff --git a/README b/README @@ -0,0 +1,38 @@ +commit heatmap generator +------------------------ + +Generate a commit heatmap web-component akin to GitHub's contributions heatmap. + +This is calculated by counting the number of commits authored by the provided +email in HEAD. This will not pick-up commits in deleted branches or squashed +commits. + + +Usage +----- + +Generate the web-component: + + $ commit-heatmap-gen git@email.com path/to/gitdir > commit-heatmap.js + +Include the generated JS file into your websites <head>: + + <script src="commit-heatmap.js"></script> + +Use the web-component: + + <commit-heatmap></commit-heatmap> + + +Dependencies +------------ + +- C compiler +- libc +- libgit2 + + +Build +----- + +$ make