Skip to content
Merged
Changes from all commits
Commits
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
10 changes: 7 additions & 3 deletions packages/pangea-node-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ v20.

## Installation

#### GA releases

Via npm:

```bash
Expand All @@ -28,7 +30,7 @@ $ yarn add pangea-node-sdk

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

### Beta releases
#### 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
Expand All @@ -50,7 +52,8 @@ $ yarn add pangea-node-sdk@3.8.0-beta.2
## Usage

- [Documentation][]
- [Examples][]
- [GA Examples][]
- [Beta Examples][]

General usage would be to create a token for a service through the
[Pangea Console][] and then construct an API client for that respective service.
Expand All @@ -74,7 +77,8 @@ const response = await audit.log({ message: "Hello, World!" });
```

[Documentation]: https://pangea.cloud/docs/sdk/js/
[Examples]: https://github.com/pangeacyber/pangea-javascript/tree/main/examples
[GA Examples]: https://github.com/pangeacyber/pangea-javascript/tree/main/examples
[Beta Examples]: https://github.com/pangeacyber/pangea-javascript/tree/beta/examples
[Pangea Console]: https://console.pangea.cloud/
[Slack]: https://pangea.cloud/join-slack/
[Secure Audit Log]: https://pangea.cloud/docs/audit