Skip to content

Commit

Permalink
doc: correct example invocation command example
Browse files Browse the repository at this point in the history
  • Loading branch information
arindas committed May 25, 2024
1 parent 828864f commit 20b1c69
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 9 deletions.
15 changes: 8 additions & 7 deletions .github/workflows/rust-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,19 @@ on:
branches:
- main
- develop
- 'dev/**'
- "dev/**"
paths:
- 'src/**'
- "src/**"
- "examples/**"

pull_request:
branches:
- main
- develop
- 'dev/**'
- "dev/**"
paths:
- 'src/**'
- "src/**"
- "examples/**"

jobs:
code-coverage:
Expand Down Expand Up @@ -45,8 +47,8 @@ jobs:
command: test
env:
CARGO_INCREMENTAL: 0
RUSTFLAGS: '-Cinstrument-coverage'
LLVM_PROFILE_FILE: './target/coverage.prof/cargo-test-%p-%m.profraw'
RUSTFLAGS: "-Cinstrument-coverage"
LLVM_PROFILE_FILE: "./target/coverage.prof/cargo-test-%p-%m.profraw"

- name: Install grcov
run: |
Expand Down Expand Up @@ -83,4 +85,3 @@ jobs:
with:
token: ${{ secrets.GITHUB_TOKEN }}
args: --all-features

8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,13 @@ order they need.
## Examples

Find examples demonstrating different capabilities of `laminarmq` in the
[examples](./examples) directory.
[examples](https://github.com/arindas/laminarmq/tree/main/examples) directory.

Invoke any example as follows:

```sh
cargo run --example <example-name> --release
```

## Media

Expand Down
2 changes: 1 addition & 1 deletion examples/laminarmq-tokio-commit-log-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ const DEFAULT_STORAGE_DIRECTORY: &str = "./.storage/laminarmq_tokio_commit_log_s
You may specify it as follows:

```sh
STORAGE_DIRECTORY="<storage directory>" cargo run --release
STORAGE_DIRECTORY="<storage directory>" cargo run --example laminarmq-tokio-commit-log-server --release
```

Once the server is running you may make requests as follows:
Expand Down

0 comments on commit 20b1c69

Please sign in to comment.