Skip to content

Commit a4ab922

Browse files
Chris Brodyshazron
authored andcommitted
Documentation updates & fixes (#241)
* Add compact npm badge * Xcode 9.4 support * use backticks * remove obsolete backlog reference * Update Node.js directions with minimum Node.js version 6 * Rewording in place of "make sure" in a couple places * More direct LICENSE link
1 parent 549784b commit a4ab922

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,22 @@
1+
[![NPM](https://nodei.co/npm/ios-sim.png?compact=true)](https://nodei.co/npm/ios-sim/)
12
[![Build status](https://ci.appveyor.com/api/projects/status/xh7auct40k5oxwjg/branch/master?svg=true
23
)](https://ci.appveyor.com/project/shazron/ios-sim-bn5fo)
34
[![Build Status](https://travis-ci.org/ios-control/ios-sim.svg?branch=master)](https://travis-ci.org/ios-control/ios-sim)
45

56
ios-sim
67
=======
78

8-
Supports Node 6 and greater, and Xcode 10 and greater -- since version 8.x.
9+
Supports Node 6 and greater, and Xcode 9.4 and greater -- since version 8.x.
910

10-
The ios-sim tool is a command-line utility that launches an iOS application on the iOS Simulator. This allows for niceties such as automated testing without having to open Xcode.
11+
The `ios-sim` tool is a command-line utility that launches an iOS application on the iOS Simulator. This allows for niceties such as automated testing without having to open Xcode.
1112

1213
Features
1314
--------
1415

15-
* Choose the device family to simulate, i.e. iPhone or iPad. Run using "showdevicetypes" option to see available device types, and pass it in as the "devicetypeid" parameter.
16+
* Choose the device family to simulate, i.e. iPhone or iPad. Run using `showdevicetypes` option to see available device types, and pass it in as the `devicetypeid` parameter.
1617

1718
See the `--help` option for more info.
1819

19-
The unimplemented options below are in the [backlog](https://github.com/phonegap/ios-sim/milestones/ios-sim%204.2.0)
20-
2120
Usage
2221
-----
2322

@@ -65,7 +64,7 @@ Choose one of the following installation methods.
6564

6665
### Node JS
6766

68-
Install using node.js (at least 0.10.20):
67+
Install using Node.js (6 or greater):
6968

7069
$ npm install ios-sim -g
7170

@@ -85,17 +84,15 @@ Download using git clone:
8584
Troubleshooting
8685
---------------
8786

88-
Make sure you enable Developer Mode on your machine:
87+
Be sure to enable Developer Mode on your machine:
8988

9089
$ DevToolsSecurity -enable
9190

92-
Make sure multiple instances of launchd_sim are not running:
91+
Ensure that multiple instances of `launchd_sim` are not running:
9392

9493
$ killall launchd_sim
9594

9695
License
9796
-------
9897

99-
This project is available under the MIT license. See [LICENSE][license].
100-
101-
[license]: https://github.com/phonegap/ios-sim/blob/master/LICENSE
98+
This project is available under the MIT license. See [`LICENSE`][./LICENSE].

0 commit comments

Comments
 (0)