Skip to content

Commit

Permalink
Better getting started instructions, closes #31
Browse files Browse the repository at this point in the history
  • Loading branch information
simonw authored Jul 26, 2024
1 parent 1493414 commit 135484d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,16 @@ This plugin requires an [OpenAI API key](https://platform.openai.com/api-keys).

You can set this using the `DATASETTE_SECRETS_OPENAI_API_KEY` environment variable, or you can configure the [datasette-secrets](https://github.com/datasette/datasette-secrets) plugin to allow users to enter their own plugin and save it, encrypted, in their database.

Here's how to start using this plugin with that environment variable:

```bash
DATASETTE_SECRETS_OPENAI_API_KEY="xxx" datasette data.db --root --create
# Now click or command-click the URL containing .../-/auth-token?token=...
```
- Replace `xxx` with your OpenAI API key
- The `--root` flag causes Datasette to output a link that will sign you in as root
- The `--create` flag will create the `data.db` SQLite database file if it does not exist

## Usage

This plugin provides the following features:
Expand Down

0 comments on commit 135484d

Please sign in to comment.