Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
qgadrian committed Jul 17, 2019
1 parent 2078f1b commit 9015842
Showing 1 changed file with 20 additions and 10 deletions.
30 changes: 20 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,31 @@ list](https://git-scm.com/docs/githooks).

## Table of Contents

- [Installation](#installation)
- [Backup](#backup-current-hooks)
- [Automatic](#automatic-installation)
- [Manual](#manual-installation)
- [Configuration](#configuration)
- [Execution](#execution)
- [Supported hooks](#supported-hooks)
- [Automatic](#automatic-execution)
- [Manual](#manual-execution)
<!-- vim-markdown-toc Marked -->

* [Installation](#installation)
* [Backup current hooks](#backup-current-hooks)
* [Automatic installation](#automatic-installation)
* [Manual installation](#manual-installation)
* [Configuration](#configuration)
* [Example config](#example-config)
* [Type of tasks](#type-of-tasks)
* [Command](#command)
* [Executable file](#executable-file)
* [Removing a hook](#removing-a-hook)
* [Execution](#execution)
* [Automatic execution](#automatic-execution)
* [Manual execution](#manual-execution)

<!-- vim-markdown-toc -->

## Installation

Add to dependencies:

```elixir
def deps do
[{:git_hooks, "~> 0.3.0", only: [:test, :dev], runtime: false}]
[{:git_hooks, "~> 0.3.2-pre3", only: [:test, :dev], runtime: false}]
end
```

Expand Down Expand Up @@ -70,6 +78,8 @@ Currently there are supported two configuration options:
* **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.
* **verbose**: If true, the output of the mix tasks will be visible. This can be configured globally or per git hook.

### Example config

```elixir
config :git_hooks,
verbose: true,
Expand Down

0 comments on commit 9015842

Please sign in to comment.