Skip to content

Commit 14dcabd

Browse files
Improve docs
1 parent d315b71 commit 14dcabd

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

cmd/captainhook/main.go

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
/*
2-
CaptainHook is a git hook manager and can be used to easily share git hooks with teammates.
2+
CaptainHook is a git hook manager to easily configure and share your git hooks with teammates.
33
4-
The Cap'n works with a json configuration file to easily configure actions that should
5-
get executed during git hooks. It offers a lot of features like commit message validation
4+
The Cap'n works with a json configuration file where you configure actions that should
5+
get executed during git hooks. The Cap'n has a lot of build-in features like commit message validation
66
or only executing actions if some conditions apply.
77
8-
Once you committed the config file to the repository all your teammates have
9-
to do is run `captainhook install` and they all have the same git hook setup.
8+
To set up the Cap'n you have to run the `init` command to create a configuration
9+
file followed by the `install` command to activate your local git hooks.
1010
11-
To use the Cap'n you have to run the `init` and the `install` command.
11+
Once you committed the config file to the repository your teammates just have to install the Cap'n
12+
and to run `captainhook install` and they all have the same git hook setup.
1213
1314
Usage:
1415

0 commit comments

Comments
 (0)