Browse Source

gitignore: add README (#7312)

Marc Cornellà 5 years ago
parent
commit
fccac1ddbf
1 changed files with 17 additions and 0 deletions
  1. 17 0
      plugins/gitignore/README.md

+ 17 - 0
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.