summaryrefslogtreecommitdiff
path: root/plugins/gitignore
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2019-01-31 17:25:13 -0700
committerTuowen Zhao <ztuowen@gmail.com>2019-01-31 17:25:13 -0700
commit89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095 (patch)
tree0a301691b8481163680454a1f07ca54115ec17eb /plugins/gitignore
parent075160b86c64045e661209ad7906559068b44104 (diff)
parent851899e59ea71ce8fbae738ec7aeb7a967585977 (diff)
downloadzsh-89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095.tar.gz
zsh-89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095.tar.bz2
zsh-89c9e8a7bc177d4cff6ba8d28cf6b57a9a603095.zip
Merge branch 'master' of https://github.com/robbyrussell/oh-my-zsh
Diffstat (limited to 'plugins/gitignore')
-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.