diff --git a/jrx/README.md b/jrx/README.md index 86e696c..0628ad3 100644 --- a/jrx/README.md +++ b/jrx/README.md @@ -1,5 +1,177 @@ # Jack Russell Extension -## File Tree +This is a browser extension wallet for the Aeternity payment network. It is +meant to work in the latest versions of Firefox and Chromium. + +## How it works + +You may want to read about how [AWCP](../libs/awcp/src/awcp.ts) and +[Sidekick](../sidekick/src/sidekick.ts) work first. Briefly, + +- AWCP (Aepp-Waellet Communication Protocol) defines the message protocol + between a page script (the "aepp") and a wallet (the "waellet"). A page + script is something that you include with `