diff --git a/readme.md b/readme.md index 27141a2997b705a1fd78109d87e18b3325c7b2bf..2c9b52e479b4473659b3f907d11db3fbd35dfd03 100644 --- a/readme.md +++ b/readme.md @@ -1,7 +1,13 @@ ## jrpc +it is a jsonrpc2-like framework, allowing for json rpc over multiple different protocols. -this is a weird amalgamation of go-chi and the rpc package in go-ethereum +it also has interfaces similar to chi for routing, middleware, etc. +different transports are defined, such as http, websocket, or ipc, (net.Conn), stdio (io.Reader/io.Writer) + +it also supports subscriptions, such as those in the original ethereum json-rpc specification + +it is based off of the http router chi, and the go-ethereum, sourcegraph, and gopls json-rpc packages.