From d7ba91a875c26a4243b5ad553e14e2446d3b48d5 Mon Sep 17 00:00:00 2001 From: Stephan Salzmann Date: Fri, 19 Oct 2018 15:22:09 +0200 Subject: [PATCH 1/2] Adding gitignore plugin README --- plugins/gitignore/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 plugins/gitignore/README.md 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. From 6a536f88aad20b4157e7693fa9544c7add3c3320 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20Cornell=C3=A0?= Date: Fri, 19 Oct 2018 18:46:29 +0200 Subject: [PATCH 2/2] reword and fix formatting --- plugins/gitignore/README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/plugins/gitignore/README.md b/plugins/gitignore/README.md index 12cf07bca..753dd31fd 100644 --- a/plugins/gitignore/README.md +++ b/plugins/gitignore/README.md @@ -1,6 +1,6 @@ # gitignore -This plugin enables you the use of gitignore.io from the command line. You need an active internet connection. +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: @@ -9,6 +9,9 @@ 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. + +* `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.