Skip to content

Commit

Permalink
Clarify cram usage for READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
motiejus committed Jul 6, 2016
1 parent 98552ea commit 6042e48
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 0 deletions.
3 changes: 3 additions & 0 deletions examples/ping-json/README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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
3 changes: 3 additions & 0 deletions examples/ping-thrift-gen/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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
3 changes: 3 additions & 0 deletions examples/ping-thrift/README.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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

0 comments on commit 6042e48

Please sign in to comment.