From 7685829246ec49edab6fb14e3efd9b0e904c2807 Mon Sep 17 00:00:00 2001 From: Tushar Mathur Date: Mon, 19 Dec 2022 13:26:26 +0530 Subject: [PATCH] chore: add missing file --- compose-graphql/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 compose-graphql/README.md diff --git a/compose-graphql/README.md b/compose-graphql/README.md new file mode 100644 index 0000000..25148e0 --- /dev/null +++ b/compose-graphql/README.md @@ -0,0 +1,20 @@ +## GraphQL Compose + +Built on top of [ZIO Compose]. GraphQL compose intends to solve the problem of API Composition. +It comes in two parts — + +1. **DSL:** This is used to write the composition spec. Once the spec is written, it's validated and optimized by the compiler. +2. **Runtime:** A high-performance runtime that executes takes in a graphQL request and resolves it using a composition spec. + +## Demo + +A demo usage for [jsonplaceholder] is available here — + +1. [DSL Usage] +2. [Unit Tests] + +[jsonplaceholder]: https://jsonplaceholder.typicode.com/ +[Unit Tests]: https://github.com/tailcallhq/zio-compose/blob/main/compose-graphql/src/test/scala/compose/graphql/JsonPlaceholderSpec.scala +[DSL Usage]: https://github.com/tailcallhq/zio-compose/blob/main/compose-graphql/src/test/scala/compose/graphql/internal/JsonPlaceholder.scala + +[ZIO Compose]: https://github.com/tailcallhq/zio-compose \ No newline at end of file