Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pkrll committed Jun 15, 2018
1 parent a134646 commit 2ca2d79
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
* [Command-line options](#command-line-options)
* [Installation](#installation)
* [Prerequisites](#prerequisites)
* [Tab completion](#tab-completion)
* [Acknowledgements](#acknowledgements)

## Usage
Expand Down Expand Up @@ -121,7 +122,7 @@ Options:

``Hazel`` has only been tested on macOS High Sierra (10.13), so far, and is only available for download through Github.

**Prerequisites**:
##### Prerequisites

* Swift 4.0
* Git
Expand All @@ -136,6 +137,14 @@ $ make install

This will install ``Hazel`` in ``/usr/local/bin``, along with its templates files in ``~/.hazel``.

##### Tab completion

``Hazel`` comes equipped with tab completion for ``bash`` and ``zsh``. Add the following to your startup script (``.bashrc``, ``.zshrc``, etc...) to enable tab completion:

```bash
which hazel > /dev/null && . "$( hazel --completion-path )"
```

## Acknowledgements

``Hazel`` was created by [Ardalan Samimi](https://github.com/pkrll). This project is licensed under the terms of the MIT license. The hazel nut icon was designed by [Flaticon](https://www.flaticon.com).

0 comments on commit 2ca2d79

Please sign in to comment.