on master help sign in
overview doc fixes

- improve description of the channel system - improve description of the scry interface

commit8d66a1b2e5d16c6e1a207791c2b89e13f09394e7 authortinnus-napbus <admin@tinnus-napbus.xyz> dateFri 25 Jun 2021, 15:15 (5 years ago) parent93ab53d
1 file changed+2−2
arvo/eyre/eyre.md+2−2
arvo/eyre/eyre.md+2−2
@@ -16,13 +16,13 @@ Most types of requests require the client provide a valid session cookie which i
1616
1717Eyre's channel system is the primary way of interacting with Gall agents from outside of Urbit. It provides a simple JSON API that allows you to send data to apps and subscribe for updates from apps. Updates come back on a SSE ([Server Sent Event](https://html.spec.whatwg.org/#server-sent-events)) stream which you can easily handle with an EventSource object in Javascript or the equivalent in whichever language you prefer.
1818
19−The channel system is designed to be extremely simple with just a handful of `action` and `response` JSON objects to deal with so you can focus on the logic and data structures of your external app and the Gall agent with which you're interacting.
19+The channel system is designed to be extremely simple with just a handful of `action` and `response` JSON objects to deal. Essentially it's a thin layer on top of the underlying Gall agent interface. You can poke agents, subscribe for updates, etc, just like you would from within Urbit.
2020
2121Detailed documentation of the channel system's JSON API is provided in the [External API Reference](@/docs/arvo/eyre/external-api-ref.md) document with corresponding examples in the [Examples](@/docs/arvo/eyre/examples.md#using-the-channel-system) document.
2222
2323# Scrying
2424
25−Along with the channel system, Eyre also provides a way to make read-only requests for data which are called scries. While not technically part of the channel system, you'll likely use scries in conjunction with channel `action`s.
25+Along with the channel system, Eyre also provides a way to make read-only requests for data which are called scries. Eyre's scry interface is separate to the channel system but may be useful in conjunction with it.
2626
2727Details of Eyre's scry API are in the [Scry](@/docs/arvo/eyre/external-api-ref.md#scry) section of the [External API Reference](@/docs/arvo/eyre/external-api-ref.md) document.
2828