34bc556bd3500da316e020fb2cec3ba8dc6115ab

Author
Carlo Dapor <catull@gmail.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

Added README.md

Diff

 1diff --git a/plugins/ng/README.md b/plugins/ng/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..86ad64041284fd29f7fcb34d4af0dfb59c0b1b7a
 4--- /dev/null
 5+++ b/plugins/ng/README.md
 6@@ -0,0 +1,37 @@
 7+## NG Plugin
 8+
 9+This [ng plugin](https://github.com/robbyrussell/oh-my-zsh/tree/master/plugins/ng)
10+ adds completion support for Angular's CLI (named ng).
11+
12+Ng is hosted on [ng home](https://github.com/catull/angular-cli)
13+
14+It is used to generate Angular 2 app "stubs", build those apps, configure them,
15+test them, lint them etc.
16+
17+Ahem, "stubs" is not what Angular engineers refer to the items ng can generate
18+for you.
19+
20+"Stubs" can be any one of:
21+- class
22+- component
23+- directive
24+- enum
25+- module
26+- pipe
27+- route
28+- service
29+
30+At the moment, `ng completion` creates a very rough completion for Zsh and
31+Bash.
32+
33+It is missing most of the options and a few arguments.
34+In future, this plugin may be shortened to simply being
35+
36+```zsh
37+eval `ng completion`
38+```
39+
40+There is hope this materialises in the 21st century.
41+
42+### CONTRIBUTOR
43+ - Carlo Dapor ([catull](https://github.com/catull))