diff --git a/README.md b/README.md index 69284ea..43053c6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ -# lazyCommit -To lazily create a commit message based on a git diff +# LazyCommit + +LazyCommit is a simple CLI tool to commit changes to git with a message. + +## Badges + +![Go Tests](https://github.com/jasonbirchall/lazycommit/actions/workflows/test.yml/badge.svg) +[![codecov](https://codecov.io/gh/jasonbirchall/lazycommit/branch/main/graph/badge.svg)](https://codecov.io/gh/jasonbirchall/lazycommit) + +## Installation + +To install LazyCommit, use the following command: + +```sh +go install github.com/jasonbirchall/lazycommit@latest +``` \ No newline at end of file