Skip to content

Commit

Permalink
Refactor readme
Browse files Browse the repository at this point in the history
  • Loading branch information
steegecs committed Apr 24, 2023
1 parent 1f94211 commit d4d05c1
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,14 @@ The [ChatGPT](https://openai.com/blog/chatgpt)-powered swiss army knife for the

## Getting Started

Pre-requisite: You'll need to create an [OpenAI](https://openai.com/blog/openai-api) account or request early access from [Anthropic](https://www.anthropic.com/earlyaccess).
Pre-requisite:
- You'll need to create an [OpenAI](https://openai.com/blog/openai-api) account or request early access from [Anthropic](https://www.anthropic.com/earlyaccess).
- Also, you can create a [Pinecone](https://www.pinecone.io/start) account to use their vector database.

1. Run `pip install mindflow`, or you can clone this repo and run `pip install -e path/to/mindflow`.
2. Run `mf login`:
- Register with OpenAI or Anthropic to use their models. You can find your OpenAI API key [here](https://platform.openai.com/account/api-keys).
- Register with Pinecone to use their vector search engine. You can find your Pinecone API key and Environment [here](https://www.pinecone.io/start).
- Register with Pinecone to use their vector database. You can find your Pinecone API key and Environment [here](https://www.pinecone.io/start).
3. Now, you're ready to start using MindFlow!

## Basic Usage
Expand Down

0 comments on commit d4d05c1

Please sign in to comment.