docs: Update README

RapidAI · Jul 15, 2024 · 90024f8 · 90024f8
1 parent b3d861a
commit 90024f8
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -60,8 +60,15 @@ pip install rapidocr_onnxruntime
 
 ### Usage
 
-```bash
-rapidocr_onnxruntime -img 1.jpg
+```python
+from rapidocr_onnxruntime import RapidOCR
+
+engine = RapidOCR()
+
+img_path = 'tests/test_files/ch_en_num.jpg'
+result, elapse = engine(img_path)
+print(result)
+print(elapse)
 ```
 
 ### Documentation
@@ -81,7 +88,7 @@ Full documentation can be found on [docs](https://rapidai.github.io/RapidOCRDocs
 
 <p align="left">
   <a href="https://github.com/RapidAI/RapidOCR/graphs/contributors">
-    <img src="https://contrib.rocks/image?repo=RapidAI/RapidOCR" width="50%"/>
+    <img src="https://contrib.rocks/image?repo=RapidAI/RapidOCR&max=400&columns=20" width="50%"/>
   </a>
 </p>
 

diff --git a/docs/README_zh.md b/docs/README_zh.md
@@ -61,8 +61,15 @@ pip install rapidocr_onnxruntime
 
 ### 使用
 
-```bash
-rapidocr_onnxruntime -img 1.jpg
+```python
+from rapidocr_onnxruntime import RapidOCR
+
+engine = RapidOCR()
+
+img_path = 'tests/test_files/ch_en_num.jpg'
+result, elapse = engine(img_path)
+print(result)
+print(elapse)
 ```
 
 ### 文档
@@ -82,7 +89,7 @@ rapidocr_onnxruntime -img 1.jpg
 
 <p align="left">
   <a href="https://github.com/RapidAI/RapidOCR/graphs/contributors">
-    <img src="https://contrib.rocks/image?repo=RapidAI/RapidOCR" width="50%"/>
+    <img src="https://contrib.rocks/image?repo=RapidAI/RapidOCR&max=400&columns=20" width="50%"/>
   </a>
 </p>