docs: support for Compute (#476)

* docs: support for Compute * Update DEVELOPMENT.md * Update DEVELOPMENT.md
fastly · Oct 30, 2023 · feda86c · feda86c
1 parent 262426c
commit feda86c
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
@@ -13,3 +13,20 @@
   ```bash
   $ make all
   ```
+
+## Compute
+
+Support for the [Fastly Compute](https://www.fastly.com/products/edge-compute) platform is still in development.
+
+There are known issues with the use of Go's `reflect` package and for TinyGo support to mature.
+
+> **NOTE:** The go-fastly API client uses [github.com/mitchellh/mapstructure](https://github.com/mitchellh/mapstructure)
+
+If using standard Go (not TinyGo) then a usable client can be achieved with:
+
+```go
+client, err := fastly.NewClient("FASTLY_API_KEY")
+client.HTTPClient.Transport = fsthttp.NewTransport("fastly")
+```
+
+This presumes you have a backend named `fastly` pointing to `https://api.fastly.com`
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 A Go client library for interacting with most facets of the [Fastly API](https://docs.fastly.com/api).
 
-This library is not intended for use on the [Fastly Compute](https://www.fastly.com/products/edge-compute) platform.
+> **NOTE:** This API client may not function correctly when used on the [Fastly Compute](https://www.fastly.com/products/edge-compute) platform. Support for Compute is on the roadmap but has not yet been prioritised ([details](./DEVELOPMENT.md#compute)).
 
 ## Usage