Skip to content

Commit

Permalink
refactor: readme.md structure
Browse files Browse the repository at this point in the history
  • Loading branch information
karatakis committed Nov 6, 2024
1 parent 40b5134 commit 7b04f37
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,13 @@

Explore and compare the performance of the fastest GraphQL federation routers through our comprehensive benchmarks.

- [Introduction](#introduction)
- [Benchmark Results](#benchmark-results)
- [Introduction](#introduction)
- [Architecture](#architecture)
- [Quick Start](#quick-start)
- [Resources](#resources)
- [Contribute](#contribute)

## Introduction

This document presents a comparative analysis of several renowned GraphQL Federation routers. Dive deep into the performance metrics and get insights regarding their throughput and latency.

> **NOTE:** This is a work-in-progress suite of benchmarks, and we would appreciate help from the community to add more routers or tune the existing ones for better performance.
## Benchmark Results

<!-- PERFORMANCE_RESULTS_START -->
Expand All @@ -26,6 +20,12 @@ This document presents a comparative analysis of several renowned GraphQL Federa
| [Grafbase](https://github.com/grafbase/grafbase) | `❌ / 4,586 RPS / 0.0076 sec` | `❌ / 16,269 RPS / 0.0405 sec` | `❌ / 6,681 RPS / 0.0109 sec` |
<!-- PERFORMANCE_RESULTS_END -->

## Introduction

This document presents a comparative analysis of several renowned GraphQL Federation routers. Dive deep into the performance metrics and get insights regarding their throughput and latency.

> **NOTE:** This is a work-in-progress suite of benchmarks, and we would appreciate help from the community to add more routers or tune the existing ones for better performance.
## Architecture

![image info](./files/diagram.png)
Expand All @@ -40,7 +40,7 @@ This document presents a comparative analysis of several renowned GraphQL Federa

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/

"`bash
```bash
git clone [email protected]:tailcallhq/federation-example.git
cd federation-example
sudo docker build -t tailcallhq/federation-benchmark .
Expand Down

0 comments on commit 7b04f37

Please sign in to comment.