Skip to content

Commit 6c6cc25

Browse files
committed
docs: update rapidocr_web docs
1 parent 323e93b commit 6c6cc25

File tree

1 file changed

+32
-33
lines changed

1 file changed

+32
-33
lines changed

docs/install_usage/rapidocr_web/usage.md

Lines changed: 32 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,55 +2,54 @@
22
comments: true
33
---
44

5-
<p>
6-
<a href=""><img src="https://img.shields.io/badge/Python->=3.6,<3.13-aff.svg"></a>
7-
<a href=""><img src="https://img.shields.io/badge/OS-Linux%2C%20Win%2C%20Mac-pink.svg"></a>
8-
<a href="https://pypi.org/project/rapidocr-web/"><img alt="PyPI" src="https://img.shields.io/pypi/v/rapidocr-web"></a>
9-
<a href="https://pepy.tech/project/rapidocr_web"><img src="https://static.pepy.tech/personalized-badge/rapidocr_web?period=total&units=abbreviation&left_color=grey&right_color=blue&left_text=Downloads"></a>
10-
</p>
115

12-
### 简介
6+
<div align="center">
7+
<picture>
8+
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/RapidAI/RapidOCRWeb/releases/download/v0.0.0/RapidOCR_Web_LOGO_white_font.png" width="40%">
9+
<source media="(prefers-color-scheme: light)" srcset="https://github.com/RapidAI/RapidOCRWeb/releases/download/v0.0.0/RapidOCRWeb_LOGO.png" width="40%">
10+
<img alt="Shows an illustrated sun in light mode and a moon with stars in dark mode." src="https://github.com/RapidAI/RapidOCRWeb/releases/download/v0.0.0/RapidOCRWeb_LOGO.png">
11+
</picture>
12+
13+
<br/>
14+
<a href=""><img src="https://img.shields.io/badge/Python->=3.6-aff.svg"></a>
15+
<a href=""><img src="https://img.shields.io/badge/OS-Linux%2C%20Win%2C%20Mac-pink.svg"></a>
16+
<a href="https://pepy.tech/project/rapidocr_web"><img src="https://static.pepy.tech/personalized-badge/rapidocr_web?period=total&units=abbreviation&left_color=grey&right_color=blue&left_text=Downloads"></a>
17+
<a href="https://pypi.org/project/rapidocr_api/"><img alt="PyPI" src="https://img.shields.io/pypi/v/rapidocr_api"></a>
18+
<a href="https://choosealicense.com/licenses/apache-2.0/"><img src="https://img.shields.io/badge/License-Apache%202-dfd.svg"></a>
19+
<a href="https://semver.org/"><img alt="SemVer2.0" src="https://img.shields.io/badge/SemVer-2.0-brightgreen"></a>
20+
<a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
1321

14-
- 该库是`rapidocr_onnxruntime`的web版本,依赖最新版本的[`rapidocr_onnxruntime`](../rapidocr/rapidocr_onnxruntime.md)库。
15-
- 如果想要离线部署,可以先手动下载[`rapidocr_onnxruntime`](https://pypi.org/project/rapidocr-onnxruntime/#files) whl包,再手动安装[`rapidocr_web`](https://pypi.org/project/rapidocr-web/#files) whl包来使用。
16-
- 网页上显示的推理时间具体解释如下:
22+
</div>
1723

18-
<div align="center">
19-
<img src="https://raw.githubusercontent.com/RapidAI/RapidOCR/ae529c2ba79e6cbf04c54caf2d24feb75e947ca4/assets/ocrweb_time.jpg" width="80%" height="80%">
20-
</div>
24+
### 📖 简介
2125

22-
### 安装
26+
`rapidocr_web`是基于`rapidocr`库封装的web版OCR程序。它可以让小伙们快速在本地启动OCR服务,支持剪贴板、拖拽和选择图像文件上传识别,同时具有一键复制识别文本功能。
2327

24-
```bash linenums="1"
25-
pip install rapidocr_web
26-
```
28+
整体项目采用前后端分离设计:
2729

28-
### 使用
30+
- 前端:HTML + CSS + JavaScript
31+
- 后端:Flask
2932

30-
#### 用法
33+
UI来自Cursor,自适应移动端和PC端。相比于旧有版本(v0.x),现在版本(v1.x)更加现代化。
3134

32-
```bash linenums="1"
33-
$ rapidocr_web -h
34-
usage: rapidocr_web [-h] [-ip IP] [-p PORT]
35+
### 🛠️ 安装
3536

36-
optional arguments:
37-
-h, --help show this help message and exit
38-
-ip IP, --ip IP IP Address
39-
-p PORT, --port PORT IP port
37+
```bash
38+
pip install rapidocr_web
4039
```
4140

42-
#### 运行
41+
### 🚀 使用
4342

44-
```bash linenums="1"
43+
```bash
4544
rapidocr_web -ip 0.0.0.0 -p 9003
4645
```
4746

48-
#### 浏览器打开 <http://localhost:9003/,enjoy> it
49-
50-
!!! info
47+
#### 浏览器打开 <http://localhost:9003/> ,enjoy it
5148

52-
浏览器打开的网址是`http`的,不是`https`。
49+
> [!NOTE]
50+
>
51+
> 浏览器打开的网址是`http`的,不是`https`
5352
5453
<div align="center">
55-
<img src="https://github.com/RapidAI/RapidOCR/releases/download/v1.1.0/rapidocr_web_demo.gif" width="100%" height="100%">
54+
<img src="https://github.com/RapidAI/RapidOCRWeb/releases/download/v0.0.0/demo.gif" width="100%" height="100%">
5655
</div>

0 commit comments

Comments
 (0)