Skip to content

Commit

Permalink
docs: update documentation on the API
Browse files Browse the repository at this point in the history
  • Loading branch information
eGavr committed Aug 15, 2017
1 parent 5f04d33 commit d1a2581
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -670,13 +670,10 @@ With the API, you can use Hermione programmatically in your scripts or build too
```js
const Hermione = require('hermione');

const hermione = new Hermione(config, allowOverrides);
const hermione = new Hermione(config);
```

* **config** (required) `String|Object` – Path to the configuration file that will be read relative to `process.cwd` or [configuration object](#hermioneconfjs).
* **allowOverrides** (optional) `Object` – Switch on/off [configuration override](#overriding-settings) via environment variables or CLI options:
* **env** (optional) `Boolean` – Switch on/off configuration override via environment variables. Default is `false`.
* **cli** (optional) `Boolean` - Switch on/off configuration override via CLI options. Default is `false`.
* **config** (required) `String` – Path to the configuration file that will be read relative to `process.cwd`.

### run

Expand All @@ -694,6 +691,7 @@ hermione.run(testPaths, options)
* **options** (optional) `Object`
* **reporters** (optional) `String[]` – Test result reporters.
* **browsers** (optional) `String[]` – Browsers to run tests in.
* **sets** (optional) `String[]`– Sets to run tests in.
* **grep** (optional) `RegExp` – Pattern that defines which tests to run.

### readTests
Expand Down

0 comments on commit d1a2581

Please sign in to comment.