Skip to content

Commit

Permalink
📝 Update README with usage badges and installation instructions
Browse files Browse the repository at this point in the history
Expanded the README to include badges for Go tests and code coverage, providing quick insights into the project's current status. Added an installation section with a command for users to easily install LazyCommit, enhancing usability and accessibility for new users.
  • Loading branch information
jasonBirchall committed Nov 22, 2024
1 parent 3b6b47f commit 4b0a69f
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
```

0 comments on commit 4b0a69f

Please sign in to comment.