Skip to content

Commit fbc1244

Browse files
Merge pull request #2 from prompt-foundry/client-v1
Working SDK v1
2 parents 0816fb7 + aa573e2 commit fbc1244

File tree

18 files changed

+11928
-5310
lines changed

18 files changed

+11928
-5310
lines changed

.cspell.json

Lines changed: 0 additions & 16 deletions
This file was deleted.

.eslintignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
build
1+
build
2+
src/types/openapi.d.ts

.prettierignore

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
# package.json is formatted by package managers, so we ignore it here
2-
package.json
31
build/

.vscode/settings.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
{
2-
"cSpell.userWords": [], // only use words from .cspell.json
3-
"cSpell.enabled": true,
42
"editor.formatOnSave": true,
53
"typescript.tsdk": "node_modules/typescript/lib",
64
"typescript.enablePromptUseWorkspaceTsdk": true,

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
11
# @prompt-foundry/typescript-sdk
22

3-
The Typescript/ JavasScript SDK for the prompt engineering, prompt management, and prompt testing tool.
3+
The TypeScript/ JavasScript prompt engineering, prompt management, and prompt testing tool.
44

55
## Installation
66

7-
`npm install @prompt-foundry/typescript-sdk`
7+
```bash
8+
npm install @prompt-foundry/typescript-sdk
9+
```
10+
11+
## Usage
12+
13+
```typescript
14+
import PromptFoundry from '@prompt-foundry/typescript-sdk'
15+
16+
const pf = new PromptFoundry({
17+
apiKey: '<API_KEY>'
18+
})
19+
20+
const prompt = await pf.getPrompt({ promptId: 'HELLO' })
21+
```

0 commit comments

Comments
 (0)