@cmscraft/schema 0.0.0-stage → 0.3.4

package/README.md

@@ -1,3 +1,52 @@
-# Temporary Holding Version
+# @cmscraft/schema
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The public GraphQL schema of the [CMS Craft](https://docs.cms-craft.com) API, as SDL, plus generated TypeScript types.
+Use it to generate a typed client without introspecting the live API.
+
+> Free during beta. Paid plans will follow; we will announce pricing and give notice before any charge.
+
+## Install
+
+```bash
+npm i -D @cmscraft/schema
+```
+
+`pnpm add -D @cmscraft/schema` and `yarn add -D @cmscraft/schema` work the same way.
+
+## Use as a codegen schema
+
+`@cmscraft/schema/schema.gql` is the schema file. Point [GraphQL Code Generator](https://the-guild.dev/graphql/codegen)
+at it:
+
+```ts
+// codegen.ts
+import type { CodegenConfig } from '@graphql-codegen/cli'
+
+const config: CodegenConfig = {
+	schema: 'node_modules/@cmscraft/schema/schema.gql',
+	documents: ['src/**/*.graphql'],
+	generates: {
+		'src/generated/graphql.ts': { plugins: ['typescript', 'typescript-operations'] }
+	}
+}
+
+export default config
+```
+
+## Types
+
+The generated schema types are exported from `@cmscraft/schema/types`:
+
+```ts
+import type { Query } from '@cmscraft/schema/types'
+```
+
+## Documentation
+
+Endpoint, authentication and API guides: https://docs.cms-craft.com
+
+Questions: support@cms-craft.com
+
+## License
+
+MIT