Skip to content

Commit

Permalink
write docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryooooooga committed May 2, 2021
1 parent 9c82989 commit 2815c9d
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,37 @@ GLOBAL OPTIONS:
--help, -h show help (default: false)
--version, -v print the version (default: false)
```

## Examples

```sh
$ cat ~/.config/zouch/templates/today.txt
Today is {{ Now.Format "2006-01-02" }}!

$ zouch today.txt

$ cat today.txt
Today is 2021-05-02!
```

## Installation

### From source

```sh
$ go get -u github.com/Ryooooooga/zouch
```

### From precompiled binary

https://github.com/Ryooooooga/zouch/releases/

### Using [zinit](https://github.com/zdharma/zinit)

Add the following to your `.zshrc`.

```sh
zinit ice lucid wait"0" as"program" from"gh-r" \
pick"zouch*/zouch"
zinit light 'Ryooooooga/zouch'
```

0 comments on commit 2815c9d

Please sign in to comment.