@gqloom/core 0.5.0 → 0.7.0

package/README.md

@@ -2,35 +2,38 @@
 
 # GQLoom
 
-GQLoom is a GraphQL weaver for TypeScript/JavaScript that weaves GraphQL Schema using Valibot, Zod, or Yup, and supports sophisticated type inference to provide the best development experience.
+GQLoom is a **Code First** GraphQL Schema Loom used to weave **runtime types** in the **TypeScript/JavaScript** ecosystem into a GraphQL Schema.
 
-The design of GQLoom is inspired by [tRPC](https://trpc.io/), [TypeGraphQL](https://typegraphql.com/), [Pothos](https://pothos-graphql.dev/).
+Runtime validation libraries such as [Zod](https://zod.dev/), [Valibot](https://valibot.dev/), and [Yup](https://github.com/jquense/yup) have been widely used in backend application development. Meanwhile, when using ORM libraries like [Prisma](https://www.prisma.io/), [MikroORM](https://mikro-orm.io/), and [Drizzle](https://orm.drizzle.team/), we also pre - define database table structures or entity models that contain runtime types.
+The responsibility of GQLoom is to weave these runtime types into a GraphQL Schema.
 
-## Features
-
-- 🚀 GraphQL: flexible and efficient, reducing redundant data transfers;
-- 🔒 Robust type safety: enjoy intelligent hints at development time to detect potential problems at compile time;
-- 🔋 Ready to go: middleware, contexts, subscriptions, federated graphs are ready to go;
-- 🔮 No extra magic: no decorators, no metadata and reflection, no code generation, you just need JavaScript/TypeScript;
-- 🧩 Familiar schema libraries: use the schema libraries you already know (Zod, Yup, Valibot) to build GraphQL Schema and validate inputs;
-- 🧑‍💻 Develop happily: highly readable and semantic APIs designed to keep your code tidy;
+When developing backend applications with GQLoom, you only need to write types using the Schema libraries you're familiar with. Modern Schema libraries will infer TypeScript types for you, and GQLoom will weave GraphQL types for you.
+In addition, the **resolver factory** of GQLoom can create CRUD interfaces for `Prisma`, `MikroORM`, and `Drizzle`, and supports custom input and adding middleware.
 
 ## Hello World
 
 ```ts
-import { resolver, query, weave } from "@gqloom/core"
-import { ValibotWeaver } from "@gqloom/valibot"
+import { resolver, query, ValibotWeaver } from "@gqloom/valibot"
 import * as v from "valibot"
 
 const helloResolver = resolver({
-  hello: query(v.string(), () => "world"),
+  hello: query(v.string())
+  .input({ name: v.nullish(v.string(), "World") })
+  .resolve(({ name }) => `Hello, ${name}!`),
 })
 
-export const schema = weave(ValibotWeaver, helloResolver)
+export const schema = ValibotWeaver.weave(helloResolver)
 ```
 
-Read [Introduction](https://gqloom.dev/guide/introduction.html) to learn more about GQLoom.
+## Highlights you should not miss
+
+- 🧑‍💻 **Development Experience**: Fewer boilerplate codes, semantic API design, and extensive ecosystem integration make development enjoyable.
+- 🔒 **Type Safety**: Automatically infer types from the Schema, enjoy intelligent code completion during development, and detect potential problems during compilation.
+- 🎯 **Interface Factory**: Ordinary CRUD interfaces are too simple yet too cumbersome. Let the resolver factory create them quickly.
+- 🔋 **Fully Prepared**: Middleware, context, subscriptions, and federated graphs are ready.
+- 🔮 **No Magic**: Without decorators, metadata, reflection, or code generation, it can run anywhere with just JavaScript/TypeScript.
+- 🧩 **Rich Integration**: Use your most familiar validation libraries and ORMs to build your next GraphQL application.
 
 ## Getting Started
 
-See [Getting Started](https://gqloom.dev/guide/getting-started.html) to learn how to use GQLoom.
+See [Getting Started](https://gqloom.dev/guide/getting-started.html) to learn how to use GQLoom.