Skip to content

Commit feda86c

Browse files
authored
docs: support for Compute (#476)
* docs: support for Compute * Update DEVELOPMENT.md * Update DEVELOPMENT.md
1 parent 262426c commit feda86c

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

DEVELOPMENT.md

+17
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,20 @@
1313
```bash
1414
$ make all
1515
```
16+
17+
## Compute
18+
19+
Support for the [Fastly Compute](https://www.fastly.com/products/edge-compute) platform is still in development.
20+
21+
There are known issues with the use of Go's `reflect` package and for TinyGo support to mature.
22+
23+
> **NOTE:** The go-fastly API client uses [github.com/mitchellh/mapstructure](https://github.com/mitchellh/mapstructure)
24+
25+
If using standard Go (not TinyGo) then a usable client can be achieved with:
26+
27+
```go
28+
client, err := fastly.NewClient("FASTLY_API_KEY")
29+
client.HTTPClient.Transport = fsthttp.NewTransport("fastly")
30+
```
31+
32+
This presumes you have a backend named `fastly` pointing to `https://api.fastly.com`

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
A Go client library for interacting with most facets of the [Fastly API](https://docs.fastly.com/api).
88

9-
This library is not intended for use on the [Fastly Compute](https://www.fastly.com/products/edge-compute) platform.
9+
> **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)).
1010
1111
## Usage
1212

0 commit comments

Comments
 (0)