You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update README files for improved clarity on Docker setup and API key instructions
This commit enhances both the English and Korean README files by updating the Docker setup section to emphasize a quick start approach. The requirements for Docker Desktop are clarified, and instructions for creating a `.env` file with API keys are streamlined. Additionally, the formatting of architecture-specific instructions is improved for better readability, ensuring users have clear and concise guidance for running the project with Docker.
Copy file name to clipboardExpand all lines: README.md
+17-47Lines changed: 17 additions & 47 deletions
Original file line number
Diff line number
Diff line change
@@ -32,58 +32,19 @@ MCP (Model Context Protocol) consists of three main components.
32
32
33
33
3.**MCP Server**: Lightweight programs that expose specific functionalities through the standardized model context protocol, serving as key data sources.
34
34
35
-
## Docker Setup
35
+
## Quick Start with Docker
36
36
37
37
You can easily run this project using Docker without setting up a local Python environment.
38
38
39
-
### Prerequisites
39
+
### Requirements (Docker Desktop)
40
40
41
-
-[Docker](https://www.docker.com/get-started) installed on your system
1. Create a `.env` file with your API keys in the project root directory.
47
-
48
-
(Note) Not all API keys are required. Only enter them as needed.
49
-
-`ANTHROPIC_API_KEY`: If you enter an Anthropic API key, you can use the "claude-3-7-sonnet-latest", "claude-3-5-sonnet-latest", "claude-3-haiku-latest" models.
50
-
-`OPENAI_API_KEY`: If you enter an OpenAI API key, you can use the "gpt-4o", "gpt-4o-mini" models.
3. Create a `.env` file with your API keys(from `.env.example`)
104
65
66
+
```bash
67
+
cp .env.example .env
68
+
```
69
+
70
+
Enter your issued API key in the .env file.
71
+
(Note) Not all API keys are required. Only enter what you need.
72
+
73
+
-`ANTHROPIC_API_KEY`: When entering an Anthropic API key, you will use the "claude-3-7-sonnet-latest", "claude-3-5-sonnet-latest", "claude-3-haiku-latest" models.
74
+
-`OPENAI_API_KEY`: When entering an OpenAI API key, you will use the "gpt-4o", "gpt-4o-mini" models.
0 commit comments