diff --git a/client/README.md b/client/README.md new file mode 100644 index 0000000..0f6c492 --- /dev/null +++ b/client/README.md @@ -0,0 +1,15 @@ +# TypeScript/JavaScript MTKruto Server Client + +This is a TypeScript/JavaScript client for MTKruto Server that is mostly +compatible with [MTKruto](https://mtkru.to)’s +[`Client`](https://jsr.io/@mtkruto/mtkruto/doc/~/Client) class.* + +It can run almost anywhere JavaScript runs, including serverless platforms like +Deno Deploy, Cloudflare Workers, and more. + +--- + +*Only the +[`invoke()`](https://jsr.io/@mtkruto/mtkruto/doc/~/Client#property_invoke) +method is not backwards-compatible, which is for good—it _significantly_ reduces +the bundle size. All of its functionality is persisted.