Skip to content

Commit e295121

Browse files
SabineLossRandomByte
authored andcommitted
[INTERNAL] UA Review README.md
1 parent c056ff8 commit e295121

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Examples:
9898

9999
#### serve
100100

101-
`ui5 serve [options]` starts a webserver for the current project.
101+
`ui5 serve [options]` starts a web server for the current project.
102102

103103
```
104104
Options:
@@ -125,7 +125,7 @@ Examples:
125125

126126
#### tree
127127

128-
`ui5 tree [options]` outputs the dependency tree of the current project to _stdout_. It takes all relevant parameters of ui5 build into account.
128+
`ui5 tree [options]` outputs the dependency tree of the current project to _stdout_. It takes all relevant parameters of `ui5 build` into account.
129129

130130
```
131131
Options:
@@ -159,7 +159,7 @@ Options:
159159

160160
#### versions
161161

162-
`ui5 versions [options]` show the versions of all UI5 Build and Development Tooling packages.
162+
`ui5 versions [options]` shows the versions of all UI5 Build and Development Tooling packages.
163163

164164
```
165165
Options:
@@ -174,16 +174,16 @@ Options:
174174

175175
### Local vs. Global Installation
176176

177-
In general a global installation of the UI5 CLI (`npm install --global @ui5/cli`) is recommended.
177+
In general, we recommend a global installation of the UI5 CLI (`npm install --global @ui5/cli`).
178178

179-
However, it makes sense to add the UI5 CLI as a [devDependency](https://docs.npmjs.com/files/package.json#devdependencies) (`npm install --save-dev @ui5/cli`) for a project that is using `ui5`-commands in its build or test scripts or otherwise depends on the UI5 CLI for development workflows (like Continuous Integration).
179+
However, it makes sense to add the UI5 CLI as a [devDependency](https://docs.npmjs.com/files/package.json#devdependencies) (`npm install --save-dev @ui5/cli`) for a project that is using `ui5` commands in its build or test scripts or otherwise depends on the UI5 CLI for development workflows (like continuous integration).
180180

181181
In case you have both, a local installation in one of your projects as well as a global installation, the UI5 CLI will always try to invoke the local installation. This is in part because [npm scripts](https://docs.npmjs.com/misc/scripts) defined in your `package.json` will also always invoke the local installation.
182182

183183
This behavior can be disabled by setting the environment variable `UI5_CLI_NO_LOCAL`.
184184

185185
**Example**
186-
You have a project located at `/my-application`. The project has a devDependency to `@ui5/cli` and defines a start-script `"ui5 serve"`.
186+
You have a project located at `/my-application`. The project has a devDependency to `@ui5/cli` and defines the start script `"ui5 serve"`.
187187

188188
| Current Working Directory | Command | Uses globally installed UI5 CLI | Uses locally installed UI5 CLI |
189189
| ------------------------- | ------------------------------- | :-----------------------------: | :----------------------------: |

0 commit comments

Comments
 (0)