summaryrefslogtreecommitdiff
path: root/plugins/gitignore
diff options
context:
space:
mode:
authorStephan Salzmann <kaffdaddy@insomniaonline.de>2018-10-19 15:22:09 +0200
committerStephan Salzmann <kaffdaddy@insomniaonline.de>2018-10-19 15:22:09 +0200
commitd7ba91a875c26a4243b5ad553e14e2446d3b48d5 (patch)
tree4e3e918923679212f17c5baa7634d7952a44b2b5 /plugins/gitignore
parent3a8b93727fd58ef99dd70b7899f71efa1e1d217f (diff)
downloadzsh-d7ba91a875c26a4243b5ad553e14e2446d3b48d5.tar.gz
zsh-d7ba91a875c26a4243b5ad553e14e2446d3b48d5.tar.bz2
zsh-d7ba91a875c26a4243b5ad553e14e2446d3b48d5.zip
Adding gitignore plugin README
Diffstat (limited to 'plugins/gitignore')
-rw-r--r--plugins/gitignore/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/plugins/gitignore/README.md b/plugins/gitignore/README.md
new file mode 100644
index 000000000..12cf07bca
--- /dev/null
+++ b/plugins/gitignore/README.md
@@ -0,0 +1,14 @@
+# gitignore
+
+This plugin enables you the use of 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 displays a list of all of the currently support gitignore.io templates.
+* `gi [TEMPLATENAME]` Show 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.