doc: Add links to client examples repository

polarstreams · Nov 23, 2022 · a19d3d4 · a19d3d4
1 parent ba69954
commit a19d3d4
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 4 deletions.
diff --git a/docs/getting_started/on_docker/README.md b/docs/getting_started/on_docker/README.md
@@ -8,7 +8,11 @@ docker run --rm --env BARCO_DEV_MODE=true -p 9250-9252:9250-9252 barcostreams/ba
 ```
 
 You can start producing messages using a [client library][go-client] or directly invoking the Barco's
-[REST API][rest-api], for example:
+[REST API][rest-api]. You can use your technology of choice to send requests to the REST API, there are some examples
+in [Rust][example-rust], [Node.js][example-nodejs] and others in the [Client Examples][client-examples]
+repository.
+
+For the purpose of this guide, we will use `curl` as an HTTP client.
 
 ```shell
 curl -X POST -i -d '{"hello":"world"}' \
@@ -65,3 +69,6 @@ Read more about the API flow and guarantees on the [REST API Documentation][rest
 
 [rest-api]: ../../rest_api/
 [go-client]: https://github.com/barcostreams/go-client
+[example-rust]: https://github.com/barcostreams/client-examples/tree/main/rust
+[example-nodejs]: https://github.com/barcostreams/client-examples/tree/main/nodejs
+[client-examples]: https://github.com/barcostreams/client-examples
diff --git a/docs/rest_api/consumer_flow/README.md b/docs/rest_api/consumer_flow/README.md
@@ -15,8 +15,8 @@ This is a summary of the request/response flow of a typical application that con
   * Poll each broker
 * Unregister consumer
 
-There's an [implementation example in Node.js][nodejs-example] of the request-response flow in the
-[Client Examples][client-examples] repository.
+There are implementation examples in [Rust][example-rust] and in [Node.js][example-nodejs] of the request-response
+flow in the [Client Examples][client-examples] repository.
 
 ## Inactivity timeouts
 
@@ -37,5 +37,6 @@ If a consumer wants to manually commit the reader position without requesting mo
 request](../README.md#post-v1consumercommit). Additionally, a [goodbye request](../README.md#post-v1consumergoodbye)
 will also commit the position as well as unregistering the consumer.
 
-[nodejs-example]: https://github.com/barcostreams/client-examples/tree/main/nodejs/consuming
+[example-nodejs]: https://github.com/barcostreams/client-examples/tree/main/nodejs
+[example-rust]: https://github.com/barcostreams/client-examples/tree/main/rust
 [client-examples]: https://github.com/barcostreams/client-examples/