From a3eac71a6732fe091569a1a35778b8c35aca0681 Mon Sep 17 00:00:00 2001
From: Phil Pluckthun <phil@kitten.sh>
Date: Wed, 31 Jul 2024 19:11:23 +0100
Subject: [PATCH] chore: Add per-package readme files (#363)

---
 .changeset/twelve-teachers-battle.md |  8 ++++++++
 packages/cli-utils/README.md         | 10 ++++++++++
 packages/internal/README.md          | 12 ++++++++++++
 packages/svelte-support/README.md    | 13 +++++++++++++
 packages/vue-support/README.md       | 13 +++++++++++++
 5 files changed, 56 insertions(+)
 create mode 100644 .changeset/twelve-teachers-battle.md
 create mode 100644 packages/svelte-support/README.md
 create mode 100644 packages/vue-support/README.md

diff --git a/.changeset/twelve-teachers-battle.md b/.changeset/twelve-teachers-battle.md
new file mode 100644
index 00000000..f03135ec
--- /dev/null
+++ b/.changeset/twelve-teachers-battle.md
@@ -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
diff --git a/packages/cli-utils/README.md b/packages/cli-utils/README.md
index e69de29b..7c29f049 100644
--- a/packages/cli-utils/README.md
+++ b/packages/cli-utils/README.md
@@ -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.
diff --git a/packages/internal/README.md b/packages/internal/README.md
index e69de29b..104defa4 100644
--- a/packages/internal/README.md
+++ b/packages/internal/README.md
@@ -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`!
diff --git a/packages/svelte-support/README.md b/packages/svelte-support/README.md
new file mode 100644
index 00000000..da6419c0
--- /dev/null
+++ b/packages/svelte-support/README.md
@@ -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`!
diff --git a/packages/vue-support/README.md b/packages/vue-support/README.md
new file mode 100644
index 00000000..e5835e18
--- /dev/null
+++ b/packages/vue-support/README.md
@@ -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`!