Skip to content

Commit

Permalink
chore: add README.md for monorepo
Browse files Browse the repository at this point in the history
  • Loading branch information
Teages committed Aug 11, 2024
1 parent 05c1f34 commit ce632cd
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 1 deletion.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/)
2 changes: 1 addition & 1 deletion packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit ce632cd

Please sign in to comment.