From 32a86bdd4e1b4fda8010e261b435f899e3bf067f Mon Sep 17 00:00:00 2001
From: yzlin <yzlin@fuzhi.ai>
Date: Tue, 19 Mar 2024 20:26:36 +0800
Subject: [PATCH] update readme

---
 README.md | 60 +++++++++++++++++--------------------------------------
 1 file changed, 18 insertions(+), 42 deletions(-)

diff --git a/README.md b/README.md
index 81b6a876f..027b3b243 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,7 @@ # MetaGPT: The Multi-Agent Framework
 </p>
 
 ## News
-🚀 Mar. 14, 2024: Our Data Interpreter paper is on [arxiv](https://arxiv.org/abs/2402.18679). Check the [example](https://docs.deepwisdom.ai/main/en/DataInterpreter/) and [code](https://github.com/geekan/MetaGPT/tree/main/examples/di)!
+🚀 Mar. 14, 2024: Our **Data Interpreter** paper is on [arxiv](https://arxiv.org/abs/2402.18679). Check the [example](https://docs.deepwisdom.ai/main/en/DataInterpreter/) and [code](https://github.com/geekan/MetaGPT/tree/main/examples/di)!
 
 🚀 Feb. 08, 2024: [v0.7.0](https://github.com/geekan/MetaGPT/releases/tag/v0.7.0) released, supporting assigning different LLMs to different Roles. We also introduced [Data Interpreter](https://github.com/geekan/MetaGPT/blob/main/examples/di/README.md), a powerful agent capable of solving a wide range of real-world problems.
 
@@ -55,9 +55,9 @@ ## Software Company as Multi-Agent System
 
 <p align="center">Software Company Multi-Agent Schematic (Gradually Implementing)</p>
 
-## Install
+## Get Started
 
-### Pip installation
+### Installation
 
 > Ensure that Python 3.9+ is installed on your system. You can check this by using: `python --version`.  
 > You can use conda like this: `conda create -n metagpt python=3.9 && conda activate metagpt`
@@ -68,6 +68,9 @@ # https://docs.deepwisdom.ai/main/en/guide/get_started/configuration.html
 metagpt --init-config  # it will create ~/.metagpt/config2.yaml, just modify it to your needs
 ```
 
+For detailed installation guidance, please refer to [cli_install](https://docs.deepwisdom.ai/main/en/guide/get_started/installation.html#install-stable-version)
+ or [docker_install](https://docs.deepwisdom.ai/main/en/guide/get_started/installation.html#install-with-docker)
+
 ### Configuration
 
 You can configure `~/.metagpt/config2.yaml` according to the [example](https://github.com/geekan/MetaGPT/blob/main/config/config2.example.yaml) and [doc](https://docs.deepwisdom.ai/main/en/guide/get_started/configuration.html):
@@ -82,13 +85,13 @@ ### Configuration
 
 ### Usage
 
-After installation, you can use it as CLI
+After installation, you can use MetaGPT at CLI
 
 ```bash
 metagpt "Create a 2048 game"  # this will create a repo in ./workspace
 ```
 
-or you can use it as library
+or use it as library
 
 ```python
 from metagpt.software_company import generate_repo, ProjectRepo
@@ -96,47 +99,19 @@ ### Usage
 print(repo)  # it will print the repo structure with files
 ```
 
-detail installation please refer to [cli_install](https://docs.deepwisdom.ai/main/en/guide/get_started/installation.html#install-stable-version)
- or [docker_install](https://docs.deepwisdom.ai/main/en/guide/get_started/installation.html#install-with-docker)
+You can also use its [Data Interpreter](https://github.com/geekan/MetaGPT/tree/main/examples/di)
 
-### Docker installation
-<details><summary><strong>⏬ Step 1: Download metagpt image and prepare config2.yaml </strong><i>:: click to expand ::</i></summary>
-<div>
+```python
+import asyncio
+from metagpt.roles.di.data_interpreter import DataInterpreter
 
-```bash
-docker pull metagpt/metagpt:latest
-mkdir -p /opt/metagpt/{config,workspace}
-docker run --rm metagpt/metagpt:latest cat /app/metagpt/config/config2.yaml > /opt/metagpt/config/config2.yaml
-vim /opt/metagpt/config/config2.yaml # Change the config
+async def main():
+    di = DataInterpreter()
+    await di.run("Run data analysis on sklearn Iris dataset, include a plot")
+
+asyncio.run(main())  # or await main() in a jupyter notebook setting
 ```
 
-</div>
-</details>
-
-<details><summary><strong>⏬ Step 2: Run metagpt container </strong><i>:: click to expand ::</i></summary>
-<div>
-
-```bash
-docker run --name metagpt -d \
-    --privileged \
-    -v /opt/metagpt/config/config2.yaml:/app/metagpt/config/config2.yaml \
-    -v /opt/metagpt/workspace:/app/metagpt/workspace \
-    metagpt/metagpt:latest
-```
-
-</div>
-</details>
-
-<details><summary><strong>⏬ Step 3: Use metagpt </strong><i>:: click to expand ::</i></summary>
-<div>
-
-```bash
-docker exec -it metagpt /bin/bash
-$ metagpt "Create a 2048 game"  # this will create a repo in ./workspace
-```
-
-</div>
-</details>
 
 ### QuickStart & Demo Video
 - Try it on [MetaGPT Huggingface Space](https://huggingface.co/spaces/deepwisdom/MetaGPT)
@@ -156,6 +131,7 @@ ## Tutorial
 - 🧑‍💻 Contribution
   - [Develop Roadmap](docs/ROADMAP.md)
 - 🔖 Use Cases
+  - [Data Interpreter](https://docs.deepwisdom.ai/main/en/guide/use_cases/agent/interpreter/intro.html)
   - [Debate](https://docs.deepwisdom.ai/main/en/guide/use_cases/multi_agent/debate.html)
   - [Researcher](https://docs.deepwisdom.ai/main/en/guide/use_cases/agent/researcher.html)
   - [Recepit Assistant](https://docs.deepwisdom.ai/main/en/guide/use_cases/agent/receipt_assistant.html)