Skip to content

Commit 72f2e5b

Browse files
committed
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.
1 parent 923824b commit 72f2e5b

File tree

2 files changed

+38
-59
lines changed

2 files changed

+38
-59
lines changed

README.md

Lines changed: 17 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -32,58 +32,19 @@ MCP (Model Context Protocol) consists of three main components.
3232

3333
3. **MCP Server**: Lightweight programs that expose specific functionalities through the standardized model context protocol, serving as key data sources.
3434

35-
## Docker Setup
35+
## Quick Start with Docker
3636

3737
You can easily run this project using Docker without setting up a local Python environment.
3838

39-
### Prerequisites
39+
### Requirements (Docker Desktop)
4040

41-
- [Docker](https://www.docker.com/get-started) installed on your system
42-
- Install Docker Desktop for Apple Silicon
41+
Install Docker Desktop from the link below:
4342

44-
### Run with Docker Compose
43+
- [Install Docker Desktop](https://www.docker.com/products/docker-desktop/)
4544

46-
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.
51-
52-
```bash
53-
cp .env.example .env
54-
```
55-
56-
Insert your API keys into the `.env` file.
57-
58-
```bash
59-
ANTHROPIC_API_KEY=your_anthropic_api_key(optional)
60-
OPENAI_API_KEY=your_openai_api_key(optional)
61-
```
62-
63-
2. Choose the appropriate Docker Compose file based on your system architecture.
64-
65-
#### For AMD64/x86_64 Architecture (Intel/AMD processors)
66-
67-
```bash
68-
# Run the container
69-
docker compose up -d -f docker-compose.yaml
70-
```
45+
### Running with Docker Compose
7146

72-
#### For ARM64 Architecture (Apple Silicon M1/M2/M3)
73-
74-
```bash
75-
# Run the container
76-
docker compose up -d -f docker-compose-mac.yaml
77-
```
78-
79-
3. Access the application at http://localhost:8585 in your browser
80-
81-
82-
#### Custom Configuration
83-
84-
If you need to modify ports or other settings, edit the respective docker-compose.yaml files before building.
85-
86-
## Installation
47+
1. Create a `.env` file with your API keys in the project root directory.
8748

8849
1. Clone this repository
8950

@@ -102,10 +63,19 @@ source .venv/bin/activate # On Windows, use: .venv\Scripts\activate
10263

10364
3. Create a `.env` file with your API keys(from `.env.example`)
10465

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.
75+
10576
```bash
10677
ANTHROPIC_API_KEY=your_anthropic_api_key
107-
OPENAI_API_KEY=your_openai_api_key(optional)
108-
TAVILY_API_KEY=your_tavily_api_key(optional)
78+
OPENAI_API_KEY=your_openai_api_key
10979
LANGSMITH_TRACING=true
11080
LANGSMITH_ENDPOINT=https://api.smith.langchain.com
11181
LANGSMITH_API_KEY=your_langsmith_api_key

README_KOR.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,15 @@ MCP(Model Context Protocol)는 세 가지 주요 구성 요소로 이루어져
3232

3333
3. **MCP 서버**: 표준화된 모델 컨텍스트 프로토콜을 통해 특정 기능을 노출하는 경량 프로그램으로, 주요 데이터 소스 역할을 합니다.
3434

35-
## Docker 로 실행
35+
## Docker 로 빠른 실행
3636

3737
로컬 Python 환경을 설정하지 않고도 Docker를 사용하여 이 프로젝트를 쉽게 실행할 수 있습니다.
3838

39-
### 필수 요구사항
39+
### 필수 요구사항(Docker Desktop)
4040

41-
- 시스템에 [Docker](https://www.docker.com/get-started) 설치
42-
- Docker Compose V2 (Docker Desktop에 포함됨)
41+
아래의 링크에서 Docker Desktop을 설치합니다.
42+
43+
- [Docker Desktop 설치](https://www.docker.com/products/docker-desktop/)
4344

4445
### Docker Compose로 실행하기
4546

@@ -62,14 +63,14 @@ OPENAI_API_KEY=your_openai_api_key
6263

6364
2. 시스템 아키텍처에 맞는 Docker Compose 파일 선택.
6465

65-
#### AMD64/x86_64 아키텍처(Intel/AMD 프로세서)
66+
**AMD64/x86_64 아키텍처(Intel/AMD 프로세서)**
6667

6768
```bash
6869
# 컨테이너 실행
6970
docker compose up -d -f docker-compose-KOR.yaml
7071
```
7172

72-
#### ARM64 아키텍처(Apple Silicon M1/M2/M3)
73+
**ARM64 아키텍처(Apple Silicon M1/M2/M3)**
7374

7475
```bash
7576
# 컨테이너 실행
@@ -78,11 +79,10 @@ docker compose up -d -f docker-compose-KOR-mac.yaml
7879

7980
3. 브라우저에서 http://localhost:8585 로 애플리케이션 접속
8081

81-
#### 사용자 지정 설정
82-
83-
포트나 다른 설정을 수정해야 하는 경우, 빌드 전에 해당 docker-compose-KOR.yaml 파일을 편집하세요.
82+
(참고)
83+
- 포트나 다른 설정을 수정해야 하는 경우, 빌드 전에 해당 docker-compose-KOR.yaml 파일을 편집하세요.
8484

85-
## 설치
85+
## 소스코드로 부터 직접 설치
8686

8787
1. 이 저장소를 클론합니다
8888

@@ -99,12 +99,21 @@ uv pip install -r requirements.txt
9999
source .venv/bin/activate # Windows의 경우: .venv\Scripts\activate
100100
```
101101

102-
3. API 키가 포함된 `.env` 파일을 생성합니다(`.env.example`에서)
102+
3. API 키가 포함된 `.env` 파일을 생성합니다(`.env.example` 에서 복사)
103+
104+
```bash
105+
cp .env.example .env
106+
```
107+
108+
발급 받은 API 키를 `.env` 파일에 입력합니다.
109+
110+
(참고) 모든 API 키가 필요하지 않습니다. 필요한 경우에만 입력하세요.
111+
- `ANTHROPIC_API_KEY`: Anthropic API 키를 입력할 경우 "claude-3-7-sonnet-latest", "claude-3-5-sonnet-latest", "claude-3-haiku-latest" 모델을 사용합니다.
112+
- `OPENAI_API_KEY`: OpenAI API 키를 입력할 경우 "gpt-4o", "gpt-4o-mini" 모델을 사용합니다.
103113

104114
```bash
105115
ANTHROPIC_API_KEY=your_anthropic_api_key
106116
OPENAI_API_KEY=your_openai_api_key(optional)
107-
TAVILY_API_KEY=your_tavily_api_key(optional)
108117
LANGSMITH_TRACING=true
109118
LANGSMITH_ENDPOINT=https://api.smith.langchain.com
110119
LANGSMITH_API_KEY=your_langsmith_api_key

0 commit comments

Comments
 (0)