Create README in client/

MTKruto · Apr 9, 2024 · 4f2c27c · 4f2c27c
1 parent ad49e2e
commit 4f2c27c
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/client/README.md 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.
+
+---
+
+<sub>*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.</sub>