summaryrefslogtreecommitdiff
path: root/plugins/ng
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2020-02-27 19:26:03 +0100
committerMarc Cornellà <marc.cornella@live.com>2020-02-27 19:26:55 +0100
commit2c0315dba4297ec2e87d6f503a6d907c33f51958 (patch)
tree4a8f91ddbf6dddaeeabaa05e8c5b54d55b6e19cf /plugins/ng
parent79fff1ee492a2c4d8ab09678bd5e7440cfbf03dd (diff)
downloadzsh-2c0315dba4297ec2e87d6f503a6d907c33f51958.tar.gz
zsh-2c0315dba4297ec2e87d6f503a6d907c33f51958.tar.bz2
zsh-2c0315dba4297ec2e87d6f503a6d907c33f51958.zip
ng: refactor README
Diffstat (limited to 'plugins/ng')
-rw-r--r--plugins/ng/README.md37
1 files changed, 5 insertions, 32 deletions
diff --git a/plugins/ng/README.md b/plugins/ng/README.md
index 94a450c18..29ac15aa4 100644
--- a/plugins/ng/README.md
+++ b/plugins/ng/README.md
@@ -1,37 +1,10 @@
-## NG Plugin
+# ng plugin
-This [ng plugin](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/ng)
- adds completion support for Angular's CLI (named ng).
+This plugin adds autocompletion support for [Angular's CLI](https://github.com/angular/angular-cli)
+(named `ng`).
-Ng is hosted on [ng home](https://github.com/catull/angular-cli)
-
-It is used to generate Angular 2 app "stubs", build those apps, configure them,
-test them, lint them etc.
-
-Ahem, "stubs" is not what Angular engineers refer to the items ng can generate
-for you.
-
-"Stubs" can be any one of:
-- class
-- component
-- directive
-- enum
-- module
-- pipe
-- route
-- service
-
-At the moment, `ng completion` creates a very rough completion for Zsh and
-Bash.
-
-It is missing most of the options and a few arguments.
-In future, this plugin may be shortened to simply being
+To use it, add `ng` to the plugins array of your zshrc file:
```zsh
-eval `ng completion`
+plugins=(... ng)
```
-
-There is hope this materialises in the 21st century.
-
-### CONTRIBUTOR
- - Carlo Dapor ([catull](https://github.com/catull))