diff options
Diffstat (limited to 'docs/guides/federation')
| -rw-r--r-- | docs/guides/federation/getting-started.md | 10 | ||||
| -rw-r--r-- | docs/guides/federation/writing-and-reading.md | 29 |
2 files changed, 34 insertions, 5 deletions
diff --git a/docs/guides/federation/getting-started.md b/docs/guides/federation/getting-started.md index 483a991..89d43ef 100644 --- a/docs/guides/federation/getting-started.md +++ b/docs/guides/federation/getting-started.md @@ -141,8 +141,14 @@ names them once, when it begins its record (`init --federation NAME`), and never lass reads it on its node, with everything else that counts: ```sh -continuum-party --node http://lass:secret@localhost:3000 values -# home/tv/motd "hello" (tv) +continuum-party --node http://lass:secret@localhost:3000 get home/tv/motd -r +# hello +continuum-party --node http://lass:secret@localhost:3000 get home +# { +# "tv": { +# "motd": "hello" +# } +# } ``` lass can't write there: its node refuses it, as every node does. diff --git a/docs/guides/federation/writing-and-reading.md b/docs/guides/federation/writing-and-reading.md index abd5221..c6b27ba 100644 --- a/docs/guides/federation/writing-and-reading.md +++ b/docs/guides/federation/writing-and-reading.md @@ -94,11 +94,34 @@ Votes and proposals aren't signed again: their version is behind. ## Reading -The client shows the values that count, each with who writes there, all or under a -place (`--json` as one object, by place): +The client reads what counts as JSON, as an application holds it: a place's value, or +what lies under a path as one object, the places under it and the values within theirs, +a list's items by their index; `-r` writes a string as it is, as `jq -r` does: ```sh -continuum-party --node http://lass:secret@localhost:3000 values home/tv +continuum-party get home/tv/motd -r +# hello +continuum-party get home/tv +# { +# "hosts": { +# "laptop": { +# "ip6": "42:0:a46e::1" +# } +# }, +# "motd": "hello" +# } +continuum-party get home/tv/hosts/laptop/ip6 -r +# 42:0:a46e::1 +``` + +Where a place lies under another's value (`home/tv/hosts` holding an object, and +`home/tv/hosts/laptop` a place of its own), the deeper place is the later word there. +Nothing counting at a path is an error. `values` shows the places themselves, each with +who writes there (`--json` as one object, by place): + +```sh +continuum-party values home/tv +# home/tv/hosts/laptop {"ip6":"42:0:a46e::1"} (tv) # home/tv/motd "hello" (tv) ``` |
