Skip to content

Commit

Permalink
Merge pull request stitionai#161 from cyanheads/match-config-readme
Browse files Browse the repository at this point in the history
Update README to match config.toml
  • Loading branch information
mufeedvh authored Mar 26, 2024
2 parents c00a390 + 79e66b0 commit 2fbe09d
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,12 +145,16 @@ To start using Devika, follow these steps:

Devika requires certain configuration settings and API keys to function properly. Update the `config.toml` file with the following information:

- `OPENAI_API_KEY`: Your OpenAI API key for accessing GPT models.
- `CLAUDE_API_KEY`: Your Anthropic API key for accessing Claude models.
- `BING_API_KEY`: Your Bing Search API key for web searching capabilities.
- `DATABASE_URL`: The URL for your database connection.
- `LOG_DIRECTORY`: The directory where Devika's logs will be stored.
- `PROJECT_DIRECTORY`: The directory where Devika's projects will be stored.
- `SQLITE_DB`: The path to the SQLite database file for storing Devika's data.
- `SCREENSHOTS_DIR`: The directory where screenshots captured by Devika will be stored.
- `PDFS_DIR`: The directory where PDF files processed by Devika will be stored.
- `PROJECTS_DIR`: The directory where Devika's projects will be stored.
- `LOGS_DIR`: The directory where Devika's logs will be stored.
- `REPOS_DIR`: The directory where Git repositories cloned by Devika will be stored.
- `BING`: Your Bing Search API key for web searching capabilities.
- `CLAUDE`: Your Anthropic API key for accessing Claude models.
- `NETLIFY`: Your Netlify API key for deploying and managing web projects.
- `OPENAI`: Your OpenAI API key for accessing GPT models.

Make sure to keep your API keys secure and do not share them publicly.

Expand Down

0 comments on commit 2fbe09d

Please sign in to comment.