@trpc-panel/core 1.0.1 → 1.0.3

package/README.md

@@ -19,19 +19,20 @@ Check out our [test app](https://app.trpcpanel.io)
 - 🐦 Supports nested routers, and nested input objects. The structure of the UI maps one-to-one to your API's routers and procedures.
 - 🧭 SideNav and VSCode-like procedure / router search to quickly find what you're looking for
 - ✨ [Transform](#data-transformers) data with built in `superjson` support.
+- 🔧 **Zod v4** support with full compatibility for all Zod types
 
 ## Quick Start
 
 Install with your preferred package manager:
 
 ```sh
-yarn add trpc-panel
+npm install @trpc-panel/core
 ```
 
 render your panel and return it from your backend (express example):
 
 ```js
-import { renderTrpcPanel } from "trpc-panel";
+import { renderTrpcPanel } from "@trpc-panel/core";
 // ...
 app.use("/panel", (_, res) => {
   return res.send(
@@ -48,7 +49,7 @@ In Nextjs you'd want to create an api route somewhere like `src/pages/api/panel.
 
 ```ts
 import type { NextApiRequest, NextApiResponse } from "next";
-import { renderTrpcPanel } from "trpc-panel";
+import { renderTrpcPanel } from "@trpc-panel/core";
 import { appRouter } from "../../server/api/root";
 
 export default async function handler(_: NextApiRequest, res: NextApiResponse) {
@@ -77,7 +78,7 @@ Documentation is opt-in, meaning you only need to set it up if you want to use i
 
 ```ts
 import { initTRPC } from "@trpc/server";
-import { TRPCPanelMeta } from "trpc-panel";
+import { TRPCPanelMeta } from "@trpc-panel/core";
 
 const t = initTRPC.meta<TRPCPanelMeta>().create();
 ```
@@ -132,11 +133,18 @@ app.use("/panel", (_, res) => {
 
 `trpc-panel` welcomes and encourages open source contributions. Please see our [contributing](./CONTRIBUTING.md) guide for information on how to develop locally.
 
+## Requirements
+
+- **tRPC**: v10 or v11
+- **Zod**: v4.x (^4.2.1 recommended)
+
+> **Note**: This version requires Zod v4. If you're using Zod v3, please use an earlier version of trpc-panel.
+
 ## Limitations
 
-Currently, tRPC panel supports tRPC v10 and v11 and only works with zod input schemas. With it's current design it would be feasible to easily add support for other input types as well
+Currently, tRPC panel only works with Zod input schemas. With its current design it would be feasible to easily add support for other input types as well.
 
-There are no plans to support v9 or other previous tRPC versions.
+There are no plans to support tRPC v9 or other previous tRPC versions.
 
 ### Supported zod types
 
@@ -157,13 +165,15 @@ The following are supported
 - Number
 - Object
 - Optional
+- Pipe (transform/preprocess)
 - Promise
 - String
 - Undefined
+- Void
 
 We would like to add the following types:
 
-- Union
+- Union (non-discriminated)
 - Tuple
 - Record
 - Never