Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Expand on beta docs (GEA-13344) #222

Merged
merged 1 commit into from
Mar 20, 2024
Merged

Expand on beta docs (GEA-13344) #222

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions pangea-sdk/v3/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,19 @@ A Go SDK for integrating with Pangea services. Supports Go v1.18 and above.
$ go get github.com/pangeacyber/pangea-go/pangea-sdk/v3
```

<a name="beta-releases"></a>

### Beta releases

Pre-release versions may be available with the `beta` denotation in the version
number. These releases serve to preview beta services and APIs. Per Semantic
Versioning, they are considered unstable and do not carry the same compatibility
guarantees as stable releases. [Beta changelog](https://github.com/pangeacyber/pangea-go/blob/beta/CHANGELOG.md).

```bash
$ go get github.com/pangeacyber/pangea-go/pangea-sdk/v3@v3.8.0-beta.1
```

## Usage

- [Documentation][]
Expand Down Expand Up @@ -101,17 +114,6 @@ fmt.Printf("Logged event: %s", pangea.Stringify(e))

Full code for the above example available in [the examples directory](https://github.com/pangeacyber/pangea-go/blob/main/examples/audit/log_standard_schema.go).

<a name="beta-releases"></a>

## Beta releases

Pre-release versions may be available with the `beta` denotation in the version
number. These releases serve to preview beta services and APIs. Per Semantic
Versioning, they are considered unstable and do not carry the same compatibility
guarantees as stable releases.



[Documentation]: https://pangea.cloud/docs/sdk/go/
[Examples]: https://github.com/pangeacyber/pangea-go/tree/main/examples
[Pangea Console]: https://console.pangea.cloud/
Expand Down