From 6042e48b3356128184271473dfe798f2da3bc489 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Motiejus=20Jak=C5=A1tys?= Date: Wed, 6 Jul 2016 14:32:11 +0200 Subject: [PATCH] Clarify cram usage for READMEs --- examples/ping-json/README.md | 3 +++ examples/ping-thrift-gen/README.md | 3 +++ examples/ping-thrift/README.md | 3 +++ 3 files changed, 9 insertions(+) diff --git a/examples/ping-json/README.md b/examples/ping-json/README.md index 87c3d19e..ab05656c 100644 --- a/examples/ping-json/README.md +++ b/examples/ping-json/README.md @@ -1,5 +1,7 @@ A simple ping-pong service implementation that that integrates ringpop to forward requests between nodes. +Note: this file can be [cram][3]-executed using `make test-examples`. That's why some of the example outputs below are a bit unusual. + # Running the example All commands are relative to this directory: @@ -31,3 +33,4 @@ Optionally, set the `p` header. This value will be forwarded together with the r [1]:https://github.com/uber/ringpop-common/ [2]:https://github.com/uber/tcurl +[3]:https://pypi.python.org/pypi/cram diff --git a/examples/ping-thrift-gen/README.md b/examples/ping-thrift-gen/README.md index 2f20b272..5af19d12 100644 --- a/examples/ping-thrift-gen/README.md +++ b/examples/ping-thrift-gen/README.md @@ -1,5 +1,7 @@ A simple ping-pong service implementation that that integrates ringpop to forward requests between nodes. +Note: this file can be [cram][3]-executed using `make test-examples`. That's why some of the example outputs below are a bit unusual. + This example it's different than the others because it uses ringpop specific generated code to avoid some of the boilerplate. # Running the example @@ -40,3 +42,4 @@ Optionally, set the `p` header. This value will be forwarded together with the r [1]:https://github.com/uber/ringpop-common/ [2]:https://github.com/uber/tcurl +[3]:https://pypi.python.org/pypi/cram diff --git a/examples/ping-thrift/README.md b/examples/ping-thrift/README.md index f9d67544..298a0235 100644 --- a/examples/ping-thrift/README.md +++ b/examples/ping-thrift/README.md @@ -1,5 +1,7 @@ A simple ping-pong service implementation that that integrates ringpop to forward requests between nodes. +Note: this file can be [cram][3]-executed using `make test-examples`. That's why some of the example outputs below are a bit unusual. + # Running the example All commands are relative to this directory: @@ -39,3 +41,4 @@ Optionally, set the `p` header. This value will be forwarded together with the r [1]:https://github.com/uber/ringpop-common/ [2]:https://github.com/uber/tcurl +[3]:https://pypi.python.org/pypi/cram