summaryrefslogtreecommitdiff
path: root/plugins/gitignore/README.md
diff options
context:
space:
mode:
authorKozlov Alexander <badryke@gmail.com>2018-11-16 13:38:43 +0300
committerGitHub <noreply@github.com>2018-11-16 13:38:43 +0300
commit8c95c52353118643ac3dbd9b0c185a3129b84bf8 (patch)
treeee7497251b7a541480ae5c6a97b63b14381ed5ee /plugins/gitignore/README.md
parentdd30cf104c9ca42d89d26a134382ca421869ce7e (diff)
parent3d8f2bda599c8c6d160dc448e5ab28aaf2d5e90d (diff)
downloadzsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.tar.gz
zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.tar.bz2
zsh-8c95c52353118643ac3dbd9b0c185a3129b84bf8.zip
Merge branch 'master' into master
Diffstat (limited to 'plugins/gitignore/README.md')
-rw-r--r--plugins/gitignore/README.md17
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.