Skip to content

Commit

Permalink
docs: link to the Go reference docs
Browse files Browse the repository at this point in the history
  • Loading branch information
displague authored Dec 19, 2023
1 parent 8096b49 commit c7233f2
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Equinix Go SDK

[![Maintained](https://img.shields.io/badge/stability-maintained-green.svg)](https://github.com/equinix-labs/equinix-labs/blob/main/maintained-statement.md)
[![Release](https://img.shields.io/github/v/release/equinix/equinix-sdk-go)](https://github.com/equinix/equinix-sdk-go/releases/latest)
[![GoDoc](https://godoc.org/github.com/equinix/equinix-sdk-go?status.svg)](https://godoc.org/github.com/equinix/equinix-sdk-go)

This is the official Go SDK for Equinix services. This SDK is currently provided with a major version of [v0](https://blog.golang.org/v2-go-modules). We aim to avoid breaking changes to this library, but they will certainly happen as we work towards a stable v1 library.

Expand All @@ -23,3 +25,5 @@ go get github.com/equinix/equinix-sdk-go
## Usage

You can see usage of the generated code in the [`examples` directory](https://github.com/equinix/equinix-sdk-go/tree/main/examples).

Full package documentation is available at <https://pkg.go.dev/github.com/equinix/equinix-sdk-go/services/metalv1>.

0 comments on commit c7233f2

Please sign in to comment.