From 046ec895bb19ca34ef63838e32d0e4230c61b554 Mon Sep 17 00:00:00 2001 From: Scott Rippey Date: Mon, 8 Jul 2024 12:34:40 -0600 Subject: [PATCH] Docs: updated README (#291) * docs: duplicated the `README.md` from the root to the package * docs: changeset --------- Co-authored-by: scottrippey --- .changeset/famous-clouds-repeat.md | 5 +++++ packages/groqd/README.md | 21 +++++++++++++++++++-- 2 files changed, 24 insertions(+), 2 deletions(-) create mode 100644 .changeset/famous-clouds-repeat.md diff --git a/.changeset/famous-clouds-repeat.md b/.changeset/famous-clouds-repeat.md new file mode 100644 index 00000000..53ca2af6 --- /dev/null +++ b/.changeset/famous-clouds-repeat.md @@ -0,0 +1,5 @@ +--- +"groqd": patch +--- + +Updated README to fix banner, add Support link diff --git a/packages/groqd/README.md b/packages/groqd/README.md index a8f4ac9c..6cbc0d72 100644 --- a/packages/groqd/README.md +++ b/packages/groqd/README.md @@ -1,6 +1,6 @@ -[![GROQD — Formidable, We build the modern web](https://raw.githubusercontent.com/FormidableLabs/groqd/main/groqd-Hero.png)](https://formidable.com/open-source/groqd) +[![GROQD](https://oss.nearform.com/api/banner?badge=groqd&bg=c99f46)](https://commerce.nearform.com/open-source/groqd) -**[Check out the official documentation.](https://formidable.com/open-source/groqd)** +**[Check out the official documentation.](https://commerce.nearform.com/open-source/groqd)** `groqd` is a schema-unaware, runtime-safe query builder for [GROQ](https://www.sanity.io/docs/groq). **The goal of `groqd` is to give you (most of) the flexibility of GROQ, with the runtime/type safety of [Zod](https://github.com/colinhacks/zod) and TypeScript.** @@ -28,3 +28,20 @@ const response = schema.parse(await sanityClient.fetch(query)); // { name: string, pokemons: { name: string }[] }[] // 👆👆 ``` + +## Support + +Have a question about Groqd? Submit an issue in this repository using the +["Question" template](https://github.com/FormidableLabs/groqd/issues/new?template=question.md). + +Notice something inaccurate or confusing? Feel free to [open an issue](https://github.com/FormidableLabs/groqd/issues/new/choose) or [make a pull request](https://github.com/FormidableLabs/groqd/pulls) to help improve the documentation for everyone! + +The source for our docs site lives in this repo in the [`docs`](https://github.com/FormidableLabs/groqd/blob/main/website/docs) folder. + +## Contributing + +Please see our [contributing guide](CONTRIBUTING.md). + +## Maintenance Status + +**Active:** Nearform is actively working on this project, and we expect to continue for work for the foreseeable future. Bug reports, feature requests and pull requests are welcome.