From 694d81e0dadba66a6ce978c68008104ac75cf04d Mon Sep 17 00:00:00 2001 From: omar Date: Sun, 27 Oct 2024 09:52:58 -0700 Subject: [PATCH] update README.md --- README.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 2065918..224719f 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,22 @@ -# GraphQL Server on Cloudflare Workers -

- cover + cover

GraphQL on Cloudflare Workers

- -Fast 💨
-Smooth 🧈
-& globally distributed GraphQL Server 🌐
-deployed at the edge using Cloudflare Workers 🔶 +💨 Fast
+🧈 Smooth
+🌐 globally distributed GraphQL Server
+🔶 deployed at the edge using Cloudflare Workers [![Deploy to Cloudflare Workers](https://deploy.workers.cloudflare.com/button)](https://deploy.workers.cloudflare.com/?url=https://github.com/o-az/workers-graphql) ___ -> [GraphQL Yoga](https://the-guild.dev/graphql/yoga-server/docs) - [Hono](https://hono.dev) - [GraphQL Playground](https://github.com/graphql/graphiql) - [GitHub Actions](https://github.com/features/actions) - Automatic Deployments on push to `main` +> [GraphQL Yoga](https://the-guild.dev/graphql/yoga-server/docs) - [Hono](https://hono.dev) - [GraphQL Playground](https://github.com/graphql/graphiql) - [Envelop Plugins](https://the-guild.dev/graphql/envelop/plugins) - [GitHub Actions](https://github.com/features/actions) - Auto deploy on push to `main` ___ -## Usage - -### Development +## Development locally: @@ -34,6 +29,10 @@ in browser: [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/o-az/workers-graphql) +## Usage + +examples on how to query, subscribe, access playground, introspect, see cache, etc. + ### GraphiQL Playground [workers-graphql.evm.workers.dev/graphiql](https://workers-graphql.evm.workers.dev/graphql) @@ -114,4 +113,6 @@ Then subsequent requests will be served from the cache for the next n seconds. To find out how long the cache is set to, search for `@cacheControl` in [./src/graphql.ts](./src/graphql.ts). -To try this, visit [workers-graphql.evm.workers.dev/graphql?query=%7B+slow+%7D](https://workers-graphql.evm.workers.dev/graphql?query=%7B+slow+%7D) in the browser, run the query, notice the slowness, and then run it again a few times to see the cache in action. +To try this, visit [workers-graphql.evm.workers.dev/graphql?query=%7B+slow+%7D](https://workers-graphql.evm.workers.dev/graphql?query=%7B+slow+%7D) in the browser. + +Run the query, notice the slowness, and then run it again a few times to see the cache in action.