cleanup awcp package, version bump to 0.2.3

2023-08-27 16:04:30 -06:00
parent b3cbbba803
commit 9f0e83ede8
3 changed files with 22 additions and 8 deletions
@@ -1,3 +1,16 @@
-# awcp (package documentation)
+# awcp: Aepp-Waellet Communication Protocol.

-Please click the word "Documentation" in the sidebar
+Mostly an internal package.
+
+Page scripts (aepps) and wallet browser extensions (waellets) need to talk to
+each other.  This package contains
+
+1. type definitions of the messages
+2. a list of error codes
+
+[src/awcp.ts](./src/awcp.ts) contains a detailed explanation of how the
+protocol is structured.
+
+[Sidekick](../../sidekick/) exhibits how to use this from the perspective of
+the page script (aepp), and [Jack Russell](../../jrx) exhibits how to use this
+from the perspective of the waellet.