Skip to content

Commit

Permalink
docs: readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
transitive-bullshit committed Dec 3, 2022
1 parent 288dca2 commit ddd9545
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,18 @@ def bubble_sort(lst):
return lst
```

The default functionality parses ChatGPT responses as markdown using [html-to-md](https://github.com/stonehank/html-to-md). I've found that this works really well during my testing, but if you'd rather output plaintext, you can use:
By default, ChatGPT responses are parsed as markdown using [html-to-md](https://github.com/stonehank/html-to-md). I've found that this works really well during my testing, but if you'd rather output plaintext, you can use:

```ts
const api = new ChatGPTAPI({ markdown: false })
```

A full [example](./src/example.ts) is included for testing purposes:

```
```bash
# clone repo
# install node deps
# then run
npx tsx src/example.ts
```

Expand Down

0 comments on commit ddd9545

Please sign in to comment.