Skip to content

Commit 77822a9

Browse files
author
Shane Wilson
committed
docs(readme): expands completion info
1 parent caade33 commit 77822a9

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Git Hooks and Changelog Generator based on Conventional Changelog
66

77
- [Why](#why)
88
- [What](#what)
9-
- [Install](#install)
9+
- [Installation](#installion)
1010
- [Git Hooks](#git-hooks)
1111
- [Change Log](#change-log)
1212

@@ -16,26 +16,26 @@ Git Hooks and Changelog Generator based on Conventional Changelog
1616
## What
1717
... A single file that can be added to your project that will install git hooks to standardize git commits and generate change logs automagically ...
1818

19-
## Install
19+
## Installation
2020

2121
To install **cgtools** simply drop the bin into your project directory and run `./cgtools install -v`.
2222

2323
```
24-
$ chmod u+x cgtools
25-
$ ./cgtools install -v
24+
> chmod +x cgtools # Make cgtools executable
25+
> ./cgtools install -v # Install cgtools
2626
Checking dependencies...
2727
OK
2828
Generating Git Hooks...
2929
OK
3030
```
3131

32-
### Bash Completion
32+
### Tab completion in bash and zsh
3333

34-
**cgtools** can generate *Bash Completion* with the flag `-b` or `--bash-completion`. You can test it out by sourcing the file: `source cgtools-completion.sh` or adding it to your `.bashrc`.
34+
**cgtools** can generate *tab completion* for bash and zsh with the flag `-b` or `--bash-completion`.
35+
You can test it out by sourcing the file: `source cgtools-completion.sh`.
3536

3637
```
37-
$ chmod u+x cgtools
38-
$ ./cgtools install -b -v
38+
> ./cgtools install -b -v # Install cgtools with bash completion
3939
Checking dependencies...
4040
OK
4141
Generating Git Hooks...
@@ -47,7 +47,13 @@ $ ./cgtools <tab>
4747
--help --verbose --version -h -v install logs validate
4848
```
4949

50-
Note: If you use `zsh` you might need to add the following to your `.zshrc`:
50+
#### bash instructions
51+
52+
#### zsh instructions
53+
54+
55+
56+
**Note**: If you use `zsh` you might need to add the following to your `.zshrc`:
5157

5258
```
5359
autoload bashcompinit

cgtools

9.51 MB
Binary file not shown.

0 commit comments

Comments
 (0)