Merge pull request #130 from planetscale/mscoutermarsh-patch-1

Add usage instructions with boost

Author: mscoutermarsh

README.md

@@ -80,6 +80,23 @@ const results = await conn.transaction(async (tx) => {
 console.log(results)
 ```
 
+### Usage with PlanetScale Boost
+
+To enable PlanetScale Boost, run `SET @@boost_cached_queries = true` once. All subsequent queries run on the same connection will use boost if it's enabled for the query pattern. Non-matching queries will run as normal.
+
+To learn more, visit: [Query caching with PlanetScale Boost](https://planetscale.com/docs/concepts/query-caching-with-planetscale-boost)
+
+```ts
+const conn = client.connection()
+// Enable boost for the connection
+await conn.execute('SET @@boost_cached_queries = true')
+
+const results = await conn.execute('...')
+
+// Optionally, you may disable boost for the connection by setting to false
+await conn.execute('SET @@boost_cached_queries = false')
+```
+
 ### Custom fetch function
 
 Node.js version 18 includes a built-in global `fetch` function. When using an older version of Node.js, you can provide a custom fetch function implementation. We recommend the [`undici`][1] package on which Node's built-in fetch is based.