Skip to content

Commit

Permalink
Add documentation in README and in --help
Browse files Browse the repository at this point in the history
Remove docs dir, since that's not how project documentation seems to be done.
  • Loading branch information
afternoon authored and samccone committed Feb 26, 2015
1 parent f3e9fa0 commit 053ddbc
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 14 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -375,6 +375,26 @@ $ ./node_modules/.bin/cucumber.js

**Note to Windows users:** invoke Cucumber.js with `cucumber-js` instead of `cucumber.js`. The latter is causing the operating system to invoke JScript instead of Node.js, because of the so-called file extension.

#### Formatters

Use --format to specify the formatter.

``` shell
$ cucumber.js --format=json
```

Cucumber.js provides progress (the default), summary, JSON and pretty
formatters.

You can also specify a custom formatter by providing the path to a file
implementing the formatter:

``` shell
$ cucumber.js --format=/path/to/my_formatter.js
```

Paths should be absolute or relative to the current working directory.

### Examples

A few example apps are available for you to browse:
Expand Down
14 changes: 0 additions & 14 deletions docs/commandline.md

This file was deleted.

1 change: 1 addition & 0 deletions lib/cucumber/cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ function Cli(argv) {
json : prints the feature as JSON\n\
summary : prints a summary only, after all\n\
scenarios were executed\n\
filename: load custom formatter from filename\n\
\n\
-i, --no-snippets Don't print snippets for pending steps.\n\
\n\
Expand Down

0 comments on commit 053ddbc

Please sign in to comment.