Skip to content

Commit

Permalink
Fix instalation and completion (#15)
Browse files Browse the repository at this point in the history
  • Loading branch information
turbaszek authored Apr 30, 2020
1 parent cb327ed commit 0905842
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
- repo: local
hooks:
- id: update-help-in-readme
name: Update output of breeze command in BREEZE.rst
name: Update help in README.md
entry: "./scripts/generate_cli_help.sh"
language: system
files: ^.*\.go$
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,18 +100,20 @@ than specified number of words
To set up autocomplete including book hints run one of the following:
```
# bash
source <(gonotes complete bash)
source <(gonotes completion bash)
# zsh
source <(gonotes complete zsh)
source <(gonotes completion zsh)
```
To persist the autocomplete behaviour add this selected option to
your `.bashrc` or `.zshrc`.

## Installation
Currently, you can install GoNotes in two ways:
- clone the repo and then `go build ./cmd/gonotes` and `go install .` - this will install actual master
- download the binary https://github.com/turbaszek/gonotes/releases/download/v0.1-alpha.2/gonotes
- clone the repo and then `go install ./cmd/gonotes` - this will install actual master
- download the binary:
```
curl -L https://github.com/turbaszek/gonotes/releases/download/v0.1-alpha.2/gonotes -o /usr/local/bin/gonotes && chmod +x /usr/local/bin/gonotes```

## Development
Feel free to open issues and PRs. To build the project follow are usuall go steps. Consider using
Expand Down
2 changes: 1 addition & 1 deletion internal/complete.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
// NewCompleteCommand sets autocomplete for GoNotes
func NewCompleteCommand() *cli.Command {
return &cli.Command{
Name: "complete",
Name: "completion",
Usage: "Setup autocomplete",
ArgsUsage: "SHELL",
Hidden: true,
Expand Down

0 comments on commit 0905842

Please sign in to comment.