From 1b46d9af9341d62ec24f8458e7bb1e75a206dfb7 Mon Sep 17 00:00:00 2001 From: fern-api <115122769+fern-api[bot]@users.noreply.github.com> Date: Tue, 4 Jul 2023 15:32:20 +0000 Subject: [PATCH] Release 0.0.15 --- README.md | 49 ------------------------------------------------- 1 file changed, 49 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index b3ec226..0000000 --- a/README.md +++ /dev/null @@ -1,49 +0,0 @@ -# HookDeck Go Library - -The HookDeck Go library provides convenient access to the HookDeck API from Go. - -[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern) - -## Usage - -```go -package main - -import ( - "context" - "fmt" - "net/http" - - hookdeck "github.com/fern-hookdeck/hookdeck-go" - "github.com/fern-hookdeck/hookdeck-go/core" -) - -func run() error { - client := hookdeck.NewClient( - "https://api.hookdeck.com", - http.DefaultClient, - core.ClientWithAuthBearer(""), - ) -} -``` - -## Known Gaps -Fern's Go SDK generator is currently in beta and we are working on the following features to improve the generated SDK: -1. Docs: The SDK will embed any docs defined in your OpenAPI within the SDK itself -2. First-class support for default URL: Rather than having the client specify `https://api.hookdeck.com`, this will be the default behavior in the SDK. - -## Beta status - -This SDK is in beta, and there may be breaking changes between versions without a major version update. -Therefore, we recommend pinning the package version to a specific version in your `go.mod` file. This way, -you can install the same version each time without breaking changes unless you are intentionally looking -for the latest version. - -## Contributing - -While we value open-source contributions to this SDK, this library is generated programmatically. Additions -made directly to this library would have to be moved over to our generation code, otherwise they would be -overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we -will not be able to merge it as-is. We suggest opening an issue first to discuss with us! - -On the other hand, contributions to the README are always very welcome!