diff --git a/README.md b/README.md new file mode 100644 index 0000000..7407e39 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# GQFn + +GQFn provides a *typed* way to write GraphQL queries with the help of TypeScript. + +- ✨ [Stackblitz Playground](https://stackblitz.com/~/github.com/Teages/gqf-playground?file=src/index.ts) +- 📖 [Documentation](https://gqfn.teages.xyz) + +## Usage + +Install package: + +```sh +# ✨ Auto-detect +npx nypm i @gqfn/core + +# npm +npm install @gqfn/core + +# yarn +yarn add @gqfn/core + +# pnpm +pnpm install @gqfn/core + +# bun +bun install @gqfn/core +``` + +- Nuxt module is available: [@gqfn/nuxt](https://gqfn.teages.xyz/ecosystem/nuxt/) diff --git a/packages/core/README.md b/packages/core/README.md index 767edcb..0717765 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -11,7 +11,7 @@ > > The package is fully completed, but unit tests, export names, and some non-major functions may have break change. -Writing GraphQL queries with type safety and type hints, power by TypeScript. +GQFn provides a *typed* way to write GraphQL queries with the help of TypeScript. - ✨ [Stackblitz Playground](https://stackblitz.com/~/github.com/Teages/gqf-playground?file=src/index.ts) - 📖 [Documentation](https://gqf.teages.xyz)