doc: correct example invocation command example

arindas · May 25, 2024 · 20b1c69 · 20b1c69
1 parent 828864f
commit 20b1c69
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 9 deletions.
diff --git a/.github/workflows/rust-ci.yml b/.github/workflows/rust-ci.yml
@@ -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:
@@ -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: |
@@ -83,4 +85,3 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           args: --all-features
-
diff --git a/README.md b/README.md
@@ -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
 

diff --git a/examples/laminarmq-tokio-commit-log-server/README.md b/examples/laminarmq-tokio-commit-log-server/README.md
@@ -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: