Skip to content
This repository was archived by the owner on May 5, 2023. It is now read-only.

Commit 357cbee

Browse files
committed
docs: update README.md
1 parent 89f77cf commit 357cbee

File tree

1 file changed

+46
-23
lines changed

1 file changed

+46
-23
lines changed

README.md

Lines changed: 46 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,57 @@
11
<div align="center">
22

3-
# 新冠肺炎实时接口 {docsify-ignore}
4-
5-
<!-- Place this tag where you want the button to render. -->
6-
<a class="github-button" href="https://github.com/leafcoder/django-covid19/subscription" data-color-scheme="no-preference: light; light: light; dark: dark;" data-show-count="true" aria-label="Watch leafcoder/django-covid19 on GitHub">
7-
<img alt="GitHub forks" src="https://img.shields.io/github/watchers/leafcoder/django-covid19?style=social">
8-
</a>
9-
<a class="github-button" href="https://github.com/leafcoder/django-covid19" data-color-scheme="no-preference: light; light: light; dark: dark;" data-show-count="true" aria-label="Star leafcoder/django-covid19 on GitHub">
10-
<img alt="GitHub forks" src="https://img.shields.io/github/stars/leafcoder/django-covid19?style=social">
11-
</a>
12-
<a class="github-button" href="https://github.com/leafcoder/django-covid19/fork" data-color-scheme="no-preference: light; light: light; dark: dark;" data-show-count="true" aria-label="Fork leafcoder/django-covid19 on GitHub">
13-
<img alt="GitHub forks" src="https://img.shields.io/github/forks/leafcoder/django-covid19?style=social">
14-
</a>
15-
16-
![GitHub release (latest by date)](https://img.shields.io/github/v/release/leafcoder/django-covid19)
17-
![GitHub top language](https://img.shields.io/github/languages/top/leafcoder/django-covid19)
18-
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/leafcoder/django-covid19)
19-
![GitHub commit activity](https://img.shields.io/github/commit-activity/w/leafcoder/django-covid19)
20-
![GitHub All Releases](https://img.shields.io/github/downloads/leafcoder/django-covid19/total)
3+
# 新冠肺炎实时接口
4+
5+
<p>
6+
<!-- Place this tag where you want the button to render. -->
7+
<a class="github-button" href="https://github.com/leafcoder/django-covid19/subscription" data-color-scheme="no-preference: light; light: light; dark: dark;" data-show-count="true" aria-label="Watch leafcoder/django-covid19 on GitHub">
8+
<img alt="GitHub forks" src="https://img.shields.io/github/watchers/leafcoder/django-covid19?style=social">
9+
</a>
10+
<a class="github-button" href="https://github.com/leafcoder/django-covid19" data-color-scheme="no-preference: light; light: light; dark: dark;" data-show-count="true" aria-label="Star leafcoder/django-covid19 on GitHub">
11+
<img alt="GitHub forks" src="https://img.shields.io/github/stars/leafcoder/django-covid19?style=social">
12+
</a>
13+
<a class="github-button" href="https://github.com/leafcoder/django-covid19/fork" data-color-scheme="no-preference: light; light: light; dark: dark;" data-show-count="true" aria-label="Fork leafcoder/django-covid19 on GitHub">
14+
<img alt="GitHub forks" src="https://img.shields.io/github/forks/leafcoder/django-covid19?style=social">
15+
</a>
16+
</p>
17+
18+
<p>
19+
<img src="https://img.shields.io/github/v/release/leafcoder/django-covid19" data-origin="https://img.shields.io/github/v/release/leafcoder/django-covid19" alt="GitHub release (latest by date)">
20+
<img src="https://img.shields.io/github/languages/top/leafcoder/django-covid19" data-origin="https://img.shields.io/github/languages/top/leafcoder/django-covid19" alt="GitHub top language">
21+
<img src="https://img.shields.io/github/languages/code-size/leafcoder/django-covid19" data-origin="https://img.shields.io/github/languages/code-size/leafcoder/django-covid19" alt="GitHub code size in bytes">
22+
<img src="https://img.shields.io/github/commit-activity/w/leafcoder/django-covid19" data-origin="https://img.shields.io/github/commit-activity/w/leafcoder/django-covid19" alt="GitHub commit activity">
23+
<img src="https://img.shields.io/github/downloads/leafcoder/django-covid19/total" data-origin="https://img.shields.io/github/downloads/leafcoder/django-covid19/total" alt="GitHub All Releases">
24+
</p>
2125

2226
</div>
2327

24-
# 接口文档
28+
# 项目文档
2529

26-
点击查看 [在线接口文档](https://blog.leafcoder.cn/django-covid19/)
30+
本项目使用开源文档工具 [docsify](https://docsify.js.org) 编写了一份开发文档。
31+
32+
文档将如何安装部署本项目作了详细的描述,开发者可根据自身需求搭建一个属于个人
33+
*新冠肺炎实时接口*,并通过项目提供的爬虫工具实时、定时的更新疫情数据,追踪
34+
疫情的最新情况。
35+
36+
如果开发者本身没有个人的云服务器用来部署本项目,也可以直接调用本项目已部署好
37+
的实时接口,可用于科研、娱乐、教学等各方面。
38+
39+
[![在线文档](docs/images/docs.png)](http://111.231.75.86:8000/docs/)
2740

2841
# 在线大屏
2942

30-
点击查看 [在线数据大屏](http://111.231.75.86/dashboard)
43+
根据已部署的疫情在线接口,并结合使用开源数据大屏项目中的示例代码,本项目提
44+
供了一个使用本项目接口的数据大屏示例。
45+
46+
[![在线数据大屏](docs/images/dashboard.png)](http://111.231.75.86/dashboard)
47+
48+
# 问题相关
49+
50+
有任何问题欢迎在 github 中提 issue,或者在文档页面的最后提交[评论](http://111.231.75.86:8000/docs/#/?id=detail-1),我会尽快解答。
51+
52+
* 推荐使用评论方式提问;
53+
* 推荐使用 isuss 提交 bug;
3154

32-
# 文档预览
55+
# 致各位
3356

34-
![图片](docs/images/docs.png)
57+
如果本项目对你有所帮助,请在[此处](http://111.231.75.86:8000/docs/#/?id=detail-1)留下你的项目地址。

0 commit comments

Comments
 (0)