Skip to content

Commit

Permalink
fix: update github repository url
Browse files Browse the repository at this point in the history
  • Loading branch information
Brandon Meyerowitz committed Aug 14, 2023
1 parent 7650ad8 commit f6085a1
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@

Commonbase allows developers to integrate with any popular LLM API provider
without needing to change any code. The SDK helps with collecting data and
feedback from the users and helps you fine-tune models for your specific use case.
feedback from the users and helps you fine-tune models for your specific use
case.

[![](./docs/chat-repl.gif)](./examples/chat-repl.ts)

## Installation

Install [Commonbase from npm](https://www.npmjs.com/package/@commonbase/sdk) using your
preferred package manager:
Install [Commonbase from npm](https://www.npmjs.com/package/@commonbase/sdk)
using your preferred package manager:

```bash
npm add @commonbase/sdk
Expand All @@ -21,11 +22,12 @@ yarn add @commonbase/sdk

## Usage

A Project ID and API Key are required for all Commonbase requests. You can find your project ID
and generate an API key in the [Commonbase Dashboard](https://commonbase.com/).
A Project ID and API Key are required for all Commonbase requests. You can find
your project ID and generate an API key in the
[Commonbase Dashboard](https://commonbase.com/).

To create a completion, configure a `Client` with your API Key and provide your Project ID
and prompt to `createCompletion`.
To create a completion, configure a `Client` with your API Key and provide your
Project ID and prompt to `createCompletion`.

```typescript
import { Client } from "@commonbase/sdk";
Expand All @@ -44,4 +46,5 @@ console.log(completion.bestResult);

To stream a completion as it is generated, use `streamCompletion`.

For more examples, see [/examples](https://github.com/commonbaseapp/sdk/tree/main/examples).
For more examples, see
[/examples](https://github.com/commonbaseapp/commonbase-js/tree/main/examples).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "Commonbase is a Typescript SDK for building LLM integrations and tooling",
"repository": {
"type": "git",
"url": "[email protected]:commonbaseapp/sdk.git"
"url": "[email protected]:commonbaseapp/commonbase-js.git"
},
"keywords": [
"commonbase",
Expand Down

0 comments on commit f6085a1

Please sign in to comment.