Skip to content

Commit 867ebba

Browse files
Correcting constructor documentation in README (#5)
1 parent e83c6d1 commit 867ebba

1 file changed

Lines changed: 4 additions & 5 deletions

File tree

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Deepgram Node.js SDK
22

3-
![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/deepgram/node-sdk/CI/main) ![npm (scoped)](https://img.shields.io/npm/v/@deepgram/sdk) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-rounded)](CODE_OF_CONDUCT.md)
3+
[![CI](https://github.com/deepgram/node-sdk/actions/workflows/CI.yml/badge.svg)](https://github.com/deepgram/node-sdk/actions/workflows/CI.yml) [![npm (scoped)](https://img.shields.io/npm/v/@deepgram/sdk)](https://www.npmjs.com/package/@deepgram/sdk) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-rounded)](CODE_OF_CONDUCT.md)
44

55
Official Node.js SDK for [Deepgram](https://www.deepgram.com/)'s automated
66
speech recognition APIs.
77

8+
> This SDK only supports the new beta Deepgram API.
9+
810
To access the API you will need a Deepgram account. Sign up for free at
911
[signup][signup].
1012

@@ -29,10 +31,7 @@ yarn add @deepgram/sdk
2931
```js
3032
const { Deepgram } = require("@deepgram/sdk");
3133

32-
const deepgram = new Deepgram({
33-
apiKey: DEEPGRAM_API_KEY,
34-
apiUrl: CUSTOM_API_URL, // Optionally used for on-premises customers
35-
});
34+
const deepgram = new Deepgram(DEEPGRAM_API_KEY);
3635
```
3736

3837
## Usage

0 commit comments

Comments
 (0)