From 8209a54304eb82523ec166630c28e5a1ddd17375 Mon Sep 17 00:00:00 2001 From: Tushar Mathur Date: Fri, 22 Nov 2024 13:39:54 -0800 Subject: [PATCH] update readme --- README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 36cee16..01cb9d9 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,14 @@ Explore and compare the performance of the fastest GraphQL federation routers th - [Latency 95% Plots](#latency-95-plots) - [Architecture](#architecture) - [Components](#components) + - [Specifications](#specifications) - [Quick Start](#quick-start) - [Resources](#resources) ## Benchmark Results + ### [Small Payload - 362 bytes](./source/small.json) | Server | Status | RPS | Latency | | ---: | ---: | ---: | ---: | @@ -74,7 +76,6 @@ Explore and compare the performance of the fastest GraphQL federation routers th ![Latency 95%: big payload](./files/p95_big.png) - ## Architecture ![Architecture Image](./files/architecture.svg) @@ -97,14 +98,21 @@ Size: ## Quick Start -To run the benchmarks, you have to install Docker on your computer. We advise using Docker because it eliminates the hassle of managing benchmark dependencies. Follow the instructions provided on the official website: https://docs.docker.com/engine/install/ +1. Clone the repository -```bash -git clone git@github.com:tailcallhq/federation-example.git -cd federation-example -sudo docker build -t tailcallhq/federation-benchmark . -sudo Docker run tailcallhq/federation-benchmark:latest ./benchmark_all.sh -``` + ```bash + git clone git@github.com:tailcallhq/federation-example.git + cd federation-example + ``` + +2. Ensure you have the latest version of [Docker](https://docs.docker.com/engine/install/) + +3. Run the following command: + ```bash + docker build -t tailcallhq/federation-benchmark . + docker run tailcallhq/federation-benchmark:latest ./benchmark_all.sh + ``` +4. Wait for benchmarks to complete. ## Resources