update readme

CosmosShadow · Aug 1, 2024 · 1244c4a · 1244c4a
1 parent 5dcf3cb
commit 1244c4a
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -45,6 +45,8 @@ pip install gptpdf
 
 ## Usage
 
+### Local Usage
+
 ```python
 from gptpdf import parse_pdf
 api_key = 'Your OpenAI API Key'
@@ -55,6 +57,14 @@ print(content)
 See more in [test/test.py](test/test.py)
 
 
+
+### Google Colab
+
+see [examples/gptpdf_Quick_Tour.ipynb](examples/gptpdf_Quick_Tour.ipynb)
+
+
+
+
 ## API
 
 ### parse_pdf
@@ -124,7 +134,8 @@ Parses a PDF file into a Markdown file and returns the Markdown content along wi
       prompt=prompt,
       verbose=False,
   )
-
+```
+
 - **args"": LLM other parameters, such as `temperature`, `top_p`, `max_tokens`, `presence_penalty`, `frequency_penalty`, etc.
 
 ## Join Us 👏🏻

diff --git a/README_CN.md b/README_CN.md
@@ -36,6 +36,8 @@ pip install gptpdf
 
 ## 使用
 
+### 本地安装使用
+
 ```python
 from gptpdf import parse_pdf
 
@@ -46,6 +48,12 @@ print(content)
 
 更多内容请见 [test/test.py](test/test.py)
 
+### Google Colab
+
+详情见 [examples/gptpdf_Quick_Tour.ipynb](examples/gptpdf_Quick_Tour.ipynb)
+
+
+
 ## API
 
 ### parse_pdf