summaryrefslogtreecommitdiff
path: root/plugins/gitignore
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2018-10-19 18:46:29 +0200
committerGitHub <noreply@github.com>2018-10-19 18:46:29 +0200
commit6a536f88aad20b4157e7693fa9544c7add3c3320 (patch)
treebd89123cfde976b898e1dba46c1bd3957eb643d4 /plugins/gitignore
parentd7ba91a875c26a4243b5ad553e14e2446d3b48d5 (diff)
downloadzsh-6a536f88aad20b4157e7693fa9544c7add3c3320.tar.gz
zsh-6a536f88aad20b4157e7693fa9544c7add3c3320.tar.bz2
zsh-6a536f88aad20b4157e7693fa9544c7add3c3320.zip
reword and fix formatting
Diffstat (limited to 'plugins/gitignore')
-rw-r--r--plugins/gitignore/README.md11
1 files 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.