ng: refactor README

This commit is contained in:
Marc Cornellà 2020-02-27 19:26:03 +01:00
parent 79fff1ee49
commit 2c0315dba4

View File

@ -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))