Document CLI in readme.
This commit is contained in:
parent
5bb71e3083
commit
daebc821d7
10
README.md
10
README.md
@ -16,6 +16,16 @@ Evalexpr is [available on crates.io](https://crates.io/crates/evalexpr), and its
|
||||
<!-- cargo-sync-readme start -->
|
||||
|
||||
|
||||
## CLI
|
||||
|
||||
While primarily meant to be used as a library, `evalexpr` is also available as a command line tool.
|
||||
It can be installed and used as follows:
|
||||
|
||||
```bash
|
||||
cargo install evalexpr
|
||||
evalexpr 2 + 3 # outputs `5` to stdout.
|
||||
```
|
||||
|
||||
## Quickstart
|
||||
|
||||
Add `evalexpr` as dependency to your `Cargo.toml`:
|
||||
|
10
src/lib.rs
10
src/lib.rs
@ -1,4 +1,14 @@
|
||||
//!
|
||||
//! ## CLI
|
||||
//!
|
||||
//! While primarily meant to be used as a library, `evalexpr` is also available as a command line tool.
|
||||
//! It can be installed and used as follows:
|
||||
//!
|
||||
//! ```bash
|
||||
//! cargo install evalexpr
|
||||
//! evalexpr 2 + 3 # outputs `5` to stdout.
|
||||
//! ```
|
||||
//!
|
||||
//! ## Quickstart
|
||||
//!
|
||||
//! Add `evalexpr` as dependency to your `Cargo.toml`:
|
||||
|
Loading…
Reference in New Issue
Block a user