Skip to content

Commit 9015842

Browse files
committed
Update README
1 parent 2078f1b commit 9015842

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,23 +14,31 @@ list](https://git-scm.com/docs/githooks).
1414

1515
## Table of Contents
1616

17-
- [Installation](#installation)
18-
- [Backup](#backup-current-hooks)
19-
- [Automatic](#automatic-installation)
20-
- [Manual](#manual-installation)
21-
- [Configuration](#configuration)
22-
- [Execution](#execution)
23-
- [Supported hooks](#supported-hooks)
24-
- [Automatic](#automatic-execution)
25-
- [Manual](#manual-execution)
17+
<!-- vim-markdown-toc Marked -->
18+
19+
* [Installation](#installation)
20+
* [Backup current hooks](#backup-current-hooks)
21+
* [Automatic installation](#automatic-installation)
22+
* [Manual installation](#manual-installation)
23+
* [Configuration](#configuration)
24+
* [Example config](#example-config)
25+
* [Type of tasks](#type-of-tasks)
26+
* [Command](#command)
27+
* [Executable file](#executable-file)
28+
* [Removing a hook](#removing-a-hook)
29+
* [Execution](#execution)
30+
* [Automatic execution](#automatic-execution)
31+
* [Manual execution](#manual-execution)
32+
33+
<!-- vim-markdown-toc -->
2634

2735
## Installation
2836

2937
Add to dependencies:
3038

3139
```elixir
3240
def deps do
33-
[{:git_hooks, "~> 0.3.0", only: [:test, :dev], runtime: false}]
41+
[{:git_hooks, "~> 0.3.2-pre3", only: [:test, :dev], runtime: false}]
3442
end
3543
```
3644

@@ -70,6 +78,8 @@ Currently there are supported two configuration options:
7078
* **tasks**: A list of the commands that will be executed when running a git hook. [See types of tasks](#type-of-tasks) for more info.
7179
* **verbose**: If true, the output of the mix tasks will be visible. This can be configured globally or per git hook.
7280

81+
### Example config
82+
7383
```elixir
7484
config :git_hooks,
7585
verbose: true,

0 commit comments

Comments
 (0)