Skip to content

Commit 1aae784

Browse files
committed
Update README
1 parent 1c006f8 commit 1aae784

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

.quickhook/pre-commit-mutating/go-fmt

Lines changed: 0 additions & 3 deletions
This file was deleted.

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,16 @@ $ brew install quickhook
4444

4545
Installable debs and RPMs are available for the [latest release](https://github.com/dirk/quickhook/releases/latest).
4646

47+
```sh
48+
# Installing a .deb
49+
wget https://github.com/dirk/quickhook/releases/download/v1.5.0/quickhook-1.5.0-amd64.deb
50+
sudo apt install ./quickhook-1.5.0-amd64.deb
51+
52+
# Installing a .rpm
53+
wget https://github.com/dirk/quickhook/releases/download/v1.5.0/quickhook-1.5.0-amd64.rpm
54+
sudo rpm --install quickhook-1.5.0-amd64.rpm
55+
```
56+
4757
## Usage
4858

4959
First you'll need to install Quickhook in your repository: `quickhook install` command will discover hooks defined in the `.quickhook` directory and create Git hook shims for those. For example, the below is what you can expect from running installation in this repository:
@@ -78,11 +88,11 @@ OPTIONS:
7888

7989
## Writing hooks
8090

81-
Quickhook will look for hooks in a corresponding sub-directory of the `.quickhook` directory in your repository. For example, it will look for pre-commit hooks in `.quickhook/pre-commit/`. A hook is any executable file in that directory. See the [`go-vet`](.quickhook/pre-commit/go-vet) file for an example.
91+
Quickhook will look for hooks in a corresponding sub-directory of the `.quickhook` directory in your repository. For example, it will look for pre-commit hooks in `.quickhook/pre-commit/`. A hook is any executable file in that directory.
8292

8393
### pre-commit
8494

85-
Pre-commit hooks receive the list of staged files separated by newlines on stdin. They are expected to write their result to stdout/stderr (Quickhook doesn't care). If they exit with a non-zero exit code then the commit will be aborted and their output displayed to the user.
95+
Pre-commit hooks receive the list of staged files separated by newlines on stdin. They are expected to write their result to stdout/stderr (Quickhook doesn't care). If they exit with a non-zero exit code then the commit will be aborted and their output displayed to the user. See the [`go-vet`](.quickhook/pre-commit/go-vet) file for an example.
8696

8797
**Note**: Pre-commit hooks will be executed in parallel and should not mutate the local repository state. For this reason `git` is shimmed on the hooks' $PATH to be unavailable.
8898

0 commit comments

Comments
 (0)