Skip to content

Commit ae5f820

Browse files
Create README.md
0 parents  commit ae5f820

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Webflow Go Library
2+
3+
The Webflow Go library provides convenient access to the Webflow API from Go.
4+
5+
[![go shield](https://img.shields.io/badge/go-docs-blue)](https://pkg.go.dev/github.com/webflow/webflow-go)
6+
[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://buildwithfern.com/?utm_source=webflow/webflow-go/readme)
7+
8+
## Installation
9+
10+
Run the following command to use the Webflow Go library in your Go module:
11+
12+
```sh
13+
go get github.com/webflow/webflow-go
14+
```
15+
16+
This module requires Go version >= 1.19.
17+
18+
## Usage
19+
20+
```go
21+
#TODO
22+
```
23+
24+
## Beta status
25+
26+
This SDK is in beta, and there may be breaking changes between versions without a major version update.
27+
Therefore, we recommend pinning the package version to a specific version in your `go.mod` file. This way,
28+
you can install the same version each time without breaking changes unless you are intentionally looking
29+
for the latest version.
30+
31+
## Contributing
32+
33+
While we value open-source contributions to this SDK, this library is generated programmatically. Additions
34+
made directly to this library would have to be moved over to our generation code, otherwise they would be
35+
overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we
36+
will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
37+
38+
On the other hand, contributions to the README are always very welcome!

0 commit comments

Comments
 (0)