Skip to content

Commit 8125d4b

Browse files
authored
chore: show the CLI diagram in a separate section with some explanations (#3318)
* chore: show the CLI diagram in a separate section with some explanations * chore: use bold for emphasis * chore: fixes following PR
1 parent f35dbfc commit 8125d4b

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,10 @@ NativeScript Command-Line Interface
33
Master Branch [![Build Status](https://travis-ci.org/NativeScript/nativescript-cli.svg?branch=build)][2].
44
Get it using: `npm install nativescript@next -g`
55

6-
* Create, build, and run native apps for iOS and Android using JavaScript or TypeScript *
7-
86
The NativeScript CLI lets you create, build, and deploy [NativeScript][7]-based projects on iOS and Android devices.
97

10-
![NativeScript CLI diagram](https://github.com/NativeScript/nativescript-cli/blob/master/ns-cli.png)
11-
128
* [What is NativeScript](#what-is-nativescript "Quick overview of NativeScript, the JavaScript framework for cross-platform development of native iOS and Android apps")
9+
* [How the NativeScript CLI works](#how-the-nativescript-cli-works "How the CLI works in more detail")
1310
* [Supported Platforms](#supported-platforms "The mobile platforms you can target with NativeScript")
1411
* [System Requirements](#system-requirements "The hardware and software requirements for setting up and working with the NativeScript CLI")
1512
* [Installation](#installation "How to configure and install the NativeScript CLI")
@@ -48,6 +45,21 @@ To learn more about NativeScript, you can check the following resources:
4845

4946
[Back to Top][1]
5047

48+
How the NativeScript CLI works
49+
===
50+
51+
The NativeScript CLI is the command-line interface for interacting with NativeScript. It incorporates several important services. Consider the following diagram:
52+
53+
![NativeScript CLI diagram](https://github.com/NativeScript/nativescript-cli/blob/master/ns-cli.png)
54+
55+
* **Commands** - pretty much what every CLI does - support of different command options, input validation and help
56+
* **Devices Service** - provides the communication between NativeScript and devices/emulators/simulators used to run/debug the app. Uses iTunes to talk to iOS and adb for Android
57+
* **LiveSync Service** - redeploys applications when code changes during development
58+
* **Hooks Service** - executes custom-written hooks in developed application, thus modifying the build process
59+
* **Platforms Service** - provides app build functionalities, uses Gradle to build Android packages and Xcode for iOS.
60+
61+
[Back to Top][1]
62+
5163
Supported Platforms
5264
===
5365

0 commit comments

Comments
 (0)