Document CLI in readme.

This commit is contained in:
Sebastian Schmidt 2023-06-01 15:52:13 +03:00
parent 5bb71e3083
commit daebc821d7
2 changed files with 20 additions and 0 deletions

View File

@ -16,6 +16,16 @@ Evalexpr is [available on crates.io](https://crates.io/crates/evalexpr), and its
<!-- cargo-sync-readme start --> <!-- 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 ## Quickstart
Add `evalexpr` as dependency to your `Cargo.toml`: Add `evalexpr` as dependency to your `Cargo.toml`:

View File

@ -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 //! ## Quickstart
//! //!
//! Add `evalexpr` as dependency to your `Cargo.toml`: //! Add `evalexpr` as dependency to your `Cargo.toml`: