diff options
Diffstat (limited to 'plugins/gitignore/README.md')
| -rw-r--r-- | plugins/gitignore/README.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/plugins/gitignore/README.md b/plugins/gitignore/README.md new file mode 100644 index 000000000..753dd31fd --- /dev/null +++ b/plugins/gitignore/README.md @@ -0,0 +1,17 @@ +# gitignore + +This plugin enables you the use of [gitignore.io](https://www.gitignore.io/) from the command line. You need an active internet connection. + +To use it, add `gitignore` to the plugins array in your zshrc file: + +```zsh +plugins=(... gitignore) +``` + +## Plugin commands + +* `gi list`: List all the currently supported gitignore.io templates. + +* `gi [TEMPLATENAME]`: Show git-ignore output on the command line, e.g. `gi java` to exclude class and package files. + +* `gi [TEMPLATENAME] >> .gitignore`: Appending programming language settings to your projects .gitignore. |