Skip to content

Commit 642a14b

Browse files
committed
docs(readme): refresh with installation and usage
1 parent 68985d3 commit 642a14b

1 file changed

Lines changed: 17 additions & 21 deletions

File tree

README.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,47 +4,43 @@
44

55
# Ionic CLI
66

7-
The Ionic command line interface (CLI) is your go-to tool for developing
8-
[Ionic][ionic-homepage] apps.
7+
The Ionic command line interface (CLI) is your go-to tool for developing [Ionic][ionic-homepage] apps.
98

10-
### CLI 4 is here! :tada:
9+
### Installation
1110

12-
- Full Ionic 4 support. See [the docs](https://ionicframework.com/docs/) to get started!
13-
- Capacitor support is **experimental**.
14-
- Full Ionic 2/3 support!
15-
- Full Ionic 1 support! (requires a package install)
16-
17-
See the CLI's [`CHANGELOG.md`](https://github.com/ionic-team/ionic-cli/blob/develop/packages/ionic/CHANGELOG.md#4.0.0) for a comprehensive list of changes.
11+
```
12+
npm install -g ionic
13+
```
1814

19-
---
15+
Detailed installation instructions can be found in the [CLI documentation](https://ionicframework.com/docs/installation/cli).
2016

21-
#### More information
17+
### Usage
2218

23-
For further information on the commands and options provided by the Ionic CLI, once globally installed on your computer as described in the [CLI documentation](https://ionicframework.com/docs/installation/cli), execute `--help` commands to get to know more.
19+
The Ionic CLI ships with command documentation, accessible in your terminal by using the `--help` flag. These docs are also available [online][ionic-cli-docs].
2420

25-
* For its usage and list of global commands:
21+
* For a list of commands:
2622

2723
```
2824
ionic --help
25+
ionic cordova --help
26+
ionic capacitor --help
2927
```
3028

31-
* For the complete list of options available when starting a new project:
29+
* For command usage and a list of options:
3230

3331
```
3432
ionic start --help
33+
ionic serve --help
34+
ionic cordova run --help
3535
```
3636

3737
---
3838

39-
:book: **Documentation**:
40-
[https://ionicframework.com/docs/cli][ionic-cli-docs]
39+
:book: **Documentation**: [https://ionicframework.com/docs/cli][ionic-cli-docs]
4140

42-
:mega: **Support/Questions?** Please see our [Support Page][ionic-support] for
43-
general support questions. The issues on GitHub should be reserved for bug
44-
reports and feature requests.
41+
:mega: **Support/Questions?** Please see our [Support Page][ionic-support] for general support questions. The issues on GitHub should be reserved for bug reports and feature requests.
4542

46-
:sparkling_heart: **Want to contribute?** Please see
47-
[CONTRIBUTING.md](https://github.com/ionic-team/ionic-cli/blob/develop/CONTRIBUTING.md).
43+
:sparkling_heart: **Want to contribute?** Please see [CONTRIBUTING.md](https://github.com/ionic-team/ionic-cli/blob/develop/CONTRIBUTING.md).
4844

4945
[ionic-homepage]: https://ionicframework.com
5046
[ionic-cli-docs]: https://ionicframework.com/docs/cli

0 commit comments

Comments
 (0)