Recommend Hive GW CLI for Bun (#6074)

Co-authored-by: Kamil Kisiela <kamil.kisiela@gmail.com>
graphql-hive · Dec 19, 2024 · d1e5f03 · d1e5f03
1 parent b4a75fc
commit d1e5f03
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/packages/web/docs/src/pages/docs/gateway/deployment/runtimes/bun.mdx b/packages/web/docs/src/pages/docs/gateway/deployment/runtimes/bun.mdx
@@ -13,7 +13,16 @@ platform besides Node.js. [Bun](https://bun.sh) is a modern JavaScript runtime l
 and it supports Fetch API as a first class citizen. So the configuration is really simple like any
 other JS runtime with Hive Gateway;
 
-The following code is a simple example of how to use Hive Gateway with Bun.
+## Hive Gateway CLI
+
+You can follow the introduction page directly to [use Hive Gateway CLI](/docs/gateway#installation).
+
+Since Bun has the compatibility layer for Node.js, all Node specific features are available in Bun.
+
+## Hive Gateway Runtime
+
+Use this method only if you know what you are doing. It is recommended to use Hive Gateway CLI for
+most cases.
 
 ```ts
 import { createGatewayRuntime } from '@graphql-hive/gateway-runtime'

diff --git a/packages/web/docs/src/pages/docs/gateway/index.mdx b/packages/web/docs/src/pages/docs/gateway/index.mdx
@@ -83,6 +83,11 @@ environment. Then, you can install Hive Gateway CLI with your preferred package
 npm i @graphql-hive/gateway
 ```
 
+<Callout>
+  You can also use [Bun](https://bun.sh) as a runtime to run the JavaScript package with the same
+  installation steps.
+</Callout>
+
 </Tabs.Tab>
 
 </Tabs>