From 8843e7faa97f877b5b418347ab03321dcd3cc932 Mon Sep 17 00:00:00 2001 From: Arsen Musayelyan Date: Thu, 2 Jun 2022 14:14:18 -0700 Subject: [PATCH] Mention web client in README --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b7bc6c9..1542a45 100644 --- a/README.md +++ b/README.md @@ -17,4 +17,10 @@ This RPC framework supports creating channels to transfer data from server to cl When creating a server or client, a `CodecFunc` can be provided. An `io.ReadWriter` is passed into the `CodecFunc` and it returns a `Codec`, which is an interface that contains encode and decode functions with the same signature as `json.Decoder.Decode()` and `json.Encoder.Encode()`. -This allows any codec to be used for the transfer of the data, making it easy to create clients in different languages. \ No newline at end of file +This allows any codec to be used for the transfer of the data, making it easy to create clients in different languages. + +--- + +### Web Client + +Inside `client/web`, there is a web client for lrpc using WebSockets. It is written in ruby (I don't like JS) and translated to human-readable JS using Ruby2JS. With the `bundler` gem installed, cd into `client/web` and run `make`. This will create a new file called `lrpc.js`, which can be used within a browser. It uses `crypto.randomUUID()`, so it must be used on an https site, not http. \ No newline at end of file