Skip to content

Commit

Permalink
chore: Add per-package readme files (#363)
Browse files Browse the repository at this point in the history
  • Loading branch information
kitten authored Jul 31, 2024
1 parent 478968b commit a3eac71
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .changeset/twelve-teachers-battle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
"@gql.tada/cli-utils": patch
"@gql.tada/internal": patch
"@gql.tada/svelte-support": patch
"@gql.tada/vue-support": patch
---

Add per-package readme files
10 changes: 10 additions & 0 deletions packages/cli-utils/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# @gql.tada/cli-utils

**`@gql.tada/cli-utils`** is a support package for `gql.tada` that contains its
CLI utility and CLI main logic.

[Documentation for the CLI and CLI's exported helper functions.](https://gql-tada.0no.co/reference/gql-tada-cli)

> [!NOTE]
> You may use the CLI's exported functions to run part of the CLI's functionality
> programmatically. The exported API by this package is considered stable and public.
12 changes: 12 additions & 0 deletions packages/internal/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# @gql.tada/internal

**`@gql.tada/internal`** is a support package for `gql.tada`
and [`@0no-co/graphqlsp`](https://github.com/0no-co/graphqlsp)
that contains shared logic for both.

_There is no documentation available for this package._

> [!NOTE]
> Use this package at your own risk! This package's exported API
> is only considered stable in the context of it being consumed
> by either `@gql.tada/cli-utils` or `@0no-co/graphqlsp`!
13 changes: 13 additions & 0 deletions packages/svelte-support/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# @gql.tada/svelte-support

**`@gql.tada/svelte-support`** is a support package for the
`gql.tada` CLI (via `@gql.tada/cli-utils`).
It's used to expose transform helpers to the CLI that allow
it to parse and use `.svelte` SFC files.

_There is no documentation available for this package._

> [!NOTE]
> Use this package at your own risk! This package's exported API
> is only considered stable in the context of it being consumed
> by `@gql.tada/cli-utils`!
13 changes: 13 additions & 0 deletions packages/vue-support/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# @gql.tada/vue-support

**`@gql.tada/vue-support`** is a support package for the
`gql.tada` CLI (via `@gql.tada/cli-utils`).
It's used to expose transform helpers to the CLI that allow
it to parse and use `.vue` SFC files.

_There is no documentation available for this package._

> [!NOTE]
> Use this package at your own risk! This package's exported API
> is only considered stable in the context of it being consumed
> by `@gql.tada/cli-utils`!

0 comments on commit a3eac71

Please sign in to comment.