From c867ef0961088a33b963fa276519b1b55bcd969b Mon Sep 17 00:00:00 2001 From: Arthur Breitman Date: Tue, 4 Oct 2016 02:03:51 -0700 Subject: [PATCH] add hint in README.md to help when trying out the RPC --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 768cfdf33..56ab716be 100644 --- a/README.md +++ b/README.md @@ -102,9 +102,17 @@ in the config file. Tezos never modifies the content of an existing JSON/RPC interface ------------------ -The tezos node provides a JSON/RPC interface. It is not active by -default and it should be explicitely activated with the `rpc-port` -option. This RPC interface is self-documented and the `tezos-client` +The tezos node provides a JSON/RPC interface. Note that it is an RPC, +and it is JSON based, but it does not follow the "JSON-RPC" protocol. +It is not active by default and it should be explicitely activated with +the `rpc-port` option. Typically, if you are not trying to run a local +network and just want to explore the RPC, you should run: + +``` +./tezos-node -sandbox /path/to/a/custom/data/dir -rpc-port 8732 +``` + +The RPC interface is self-documented and the `tezos-client` is able to pretty-print the list of available RPCs. For instance, for the list of RPC provided by the Shell: