Skip to content

Commit

Permalink
docs: make the README more clean
Browse files Browse the repository at this point in the history
  • Loading branch information
mrexox committed Sep 13, 2023
1 parent 0453550 commit 74e5f37
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,22 +39,22 @@ With **Ruby**:
gem install lefthook
```

**[Installation guide](./docs/install.md)** with more different installation instructions.
**[Installation guide](./docs/install.md)** with more ways to install lefthook: [apt](./docs/install.md#deb), [brew](./docs/install.md#homebrew), [winget](./docs/install.md#winget), and others.

## Usage

Lefthook is easy to use. Once you configure and setup you can forget that it even exists and rely on the magic underneath.
Configure your hooks, install them once and forget about it: rely on the magic underneath.

#### TL;DR

```bash
# Configure your hooks
vim lefthook.yml

# Install your hooks
# Install them to the git project
lefthook install

# Enjoy the magic of lefthook
# Enjoy your work with git
git add -A && git commit -m '...'
```

Expand Down

0 comments on commit 74e5f37

Please sign in to comment.