Skip to content

Commit

Permalink
Updated wording.
Browse files Browse the repository at this point in the history
  • Loading branch information
oubiwann committed Jan 2, 2024
1 parent e733106 commit ee65795
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,23 @@ The project is written in Rust and depends upon that toolchain as well as the us

## Shell

The primary use case for mdsplode is to be managed my another long-running process that writes to mdsplode's `stdin` and reads from its `stdout`.
The primary use case for mdsplode is to be managed my another long-running process that writes to mdsplode's `stdin` and reads from its `stdout`. This is accomplished via an interactive shell.

The shell is started with that as the command on the CLI:

```shell
cargo install mdsplode
mdsplode shell
```

Or, from a clone of this repo:

```shell
cd mdsplode
make build
./bin/mdsplode
```

[![][shell-screenshot-large]][shell-screenshot-large]

A quick session:
Expand Down

0 comments on commit ee65795

Please sign in to comment.