Skip to content

Commit db71885

Browse files
author
Ed Page
committedMar 26, 2020
docs: Provide a better summary
Fixes #76
1 parent c4052d3 commit db71885

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed
 

‎README.md

+6
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@
77
![License](https://img.shields.io/crates/l/assert_cmd.svg)
88
[![Crates Status](https://img.shields.io/crates/v/assert_cmd.svg)](https://crates.io/crates/assert_cmd)
99

10+
`assert_cmd` aims to simplify the process for doing integration testing of CLIs, including:
11+
- Finding your crate's binary to test
12+
- Assert on the result of your program's run.
13+
1014
## Install
1115

1216
Add to your `Cargo.toml`:
@@ -27,6 +31,8 @@ let mut cmd = Command::cargo_bin("bin_fixture").unwrap();
2731
cmd.assert().success();
2832
```
2933

34+
See the [docs](http://docs.rs/assert_cmd) for more.
35+
3036
## Relevant crates
3137

3238
Other crates that might be useful in testing command line programs.

‎src/lib.rs

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
//! **Assert [`Command`]** - Easy command initialization and assertions.
22
//!
3-
//! `assert_cmd` includes support for:
4-
//! - Setting up your program-under-test.
5-
//! - Verifying your program-under-test.
3+
//! `assert_cmd` aims to simplify the process for doing integration testing of CLIs, including:
4+
//! - Finding your crate's binary to test
5+
//! - Assert on the result of your program's run.
66
//!
77
//! ```toml
88
//! [dependencies]
@@ -21,6 +21,7 @@
2121
//! - `current_dir`
2222
//! - `env` / `envs` / `env_remove` / `env_clear`
2323
//! - `write_stdin` / `pipe_stdin`
24+
//! - `timeout`
2425
//!
2526
//! Validate a [`Command`]:
2627
//! - `ok` / `unwrap` / `unwrap_err`

0 commit comments

Comments
 (0)
Failed to load comments.