Skip to content

Commit 2a427ce

Browse files
Update README.md
1 parent bbab41e commit 2a427ce

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,9 @@ This SDK is organized into the following resources:
4747

4848
You can install this library using `npm`.
4949

50-
`npm install [email protected]`
51-
50+
```bash
51+
npm install [email protected]
52+
```
5253

5354
## source code
5455

@@ -72,6 +73,16 @@ If you want to test out the repo but don't have a consuming app, you can run our
7273
```
7374
npm run sample --pk=<YOUR PRIVATE KEY HERE>
7475
```
76+
## OAuth Beta
77+
78+
To read about our OAuth beta for users who want to write multi-user integrations, check out this [help center article](https://help.klaviyo.com/hc/en-us/articles/18819413031067#h_01HACEKGF33GHFEH733YK2JKTT)
79+
80+
If you already are in the OAuth beta, read the documentation in the [`oauth-beta` branch](https://github.com/klaviyo/klaviyo-api-node/tree/oauth-beta) in this repo or check out the [example application](https://github.com/klaviyo-labs/node-integration-example).
81+
82+
Install the beta package with the following command:
83+
```bash
84+
npm i klaviyo-api@beta
85+
```
7586

7687
# Usage Example
7788

@@ -1919,4 +1930,4 @@ The parameters follow the same naming conventions as the resource groups and ope
19191930
We stick to the following convention for parameters/arguments
19201931
19211932
2. All query and path params that are tagged as `required` in the docs are passed as positional args.
1922-
3. There is no need to pass in your private `apiKey` for any operations, as it is defined upon api instantiation; public key is still required where its used.
1933+
3. There is no need to pass in your private `apiKey` for any operations, as it is defined upon api instantiation; public key is still required where its used.

0 commit comments

Comments
 (0)