Skip to content

Commit b86cbf7

Browse files
[skip ci]docs: improve README content (#5)
1 parent 91a7691 commit b86cbf7

File tree

2 files changed

+69
-13
lines changed

2 files changed

+69
-13
lines changed

README.md

Lines changed: 32 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,41 @@
1+
2+
3+
<div align="center">
4+
<img src="https://raw.githubusercontent.com/OpenListTeam/Logo/main/logo.svg" height="100px" alt="OpenList Logo">
5+
<h1>OpenList-Mobile</h1>
6+
</div>
7+
8+
9+
<div align="center">
10+
111
[![Release](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/release.yaml/badge.svg)](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/release.yaml)
2-
[![Test](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/build.yaml/badge.svg)](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/build.yaml)
3-
[![CheckOpenList](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/sync_openlist.yaml/badge.svg)](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/sync_openlist.yaml)
12+
[![Build](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/build.yaml/badge.svg)](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/build.yaml)
13+
[![Sync OpenList](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/sync_openlist.yaml/badge.svg)](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/sync_openlist.yaml)
14+
[![License](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](LICENSE)
15+
[![Flutter](https://img.shields.io/badge/Flutter-3.32.7-blue.svg)](https://flutter.dev/)
16+
[![OpenList](https://img.shields.io/badge/OpenList-v4.0.9-green.svg)](https://github.com/OpenListTeam/OpenList)
17+
18+
</div>
19+
20+
21+
<div align="center">
22+
<a href="README.md">🇨🇳 中文</a> | <a href="README_EN.md">🇺🇸 English</a>
23+
</div>
424

5-
# OpenList-Mobile
625

7-
OpenList-Mobile是一个基于OpenList的Android服务端,使用Google Flutter作为UI框架
26+
**OpenList-Mobile** 是一个基于 [OpenList](https://github.com/OpenListTeam/OpenList) 的移动端文件服务器应用,使用 Flutter 框架开发。支持局域网文件共享、远程访问和在线管理
827

9-
> [Github Actions](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/sync_openlist.yaml)
10-
> 每日早晚五点钟检查最新的 [OpenList](https://github.com/OpenListTeam/OpenList/releases)
11-
> 并自动构建APK,发布到 [Release](https://github.com/OpenListTeam/OpenList-Mobile/releases)
12-
> 中,您只需耐心等待片刻并在应用内检查更新即可。
28+
### 下载安装
1329

14-
<img src="./images/openlist.jpg" height="150px">
30+
#### 稳定版本
31+
- [📱 发布版](https://github.com/OpenListTeam/OpenList-Mobile/releases/latest) - 推荐使用
1532

16-
### 关于IOS
17-
理论上 [Gomobile](https://pkg.go.dev/golang.org/x/mobile/cmd/gomobile?utm_source=godoc#hdr-Build_a_library_for_Android_and_iOS) 支持IOS,项目组在积极支持中。
33+
#### 开发版本
34+
- [🔧 构建版](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/build.yaml) - 最新功能
1835

19-
# Download
36+
> **自动更新**[GitHub Actions](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/sync_openlist.yaml) 每日早晚五点自动检查最新的 [OpenList](https://github.com/OpenListTeam/OpenList/releases) 版本并构建发布,确保始终使用最新版本。
2037
21-
- [Github Action (DEV)](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/build.yaml) 开发版
2238

39+
### 支持平台
40+
- Android
41+
- iOS (实验性,仍在开发)

README_EN.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<div align="center">
2+
<img src="https://raw.githubusercontent.com/OpenListTeam/Logo/main/logo.svg" height="100px" alt="OpenList Logo">
3+
<h1>OpenList-Mobile</h1>
4+
</div>
5+
6+
7+
<div align="center">
8+
9+
[![Release](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/release.yaml/badge.svg)](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/release.yaml)
10+
[![Build](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/build.yaml/badge.svg)](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/build.yaml)
11+
[![Sync OpenList](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/sync_openlist.yaml/badge.svg)](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/sync_openlist.yaml)
12+
[![License](https://img.shields.io/badge/License-AGPL%20v3-blue.svg)](LICENSE)
13+
[![Flutter](https://img.shields.io/badge/Flutter-3.32.7-blue.svg)](https://flutter.dev/)
14+
[![OpenList](https://img.shields.io/badge/OpenList-v4.0.9-green.svg)](https://github.com/OpenListTeam/OpenList)
15+
16+
</div>
17+
18+
<div align="center">
19+
<a href="README.md">🇨🇳 中文</a> | <a href="README_EN.md">🇺🇸 English</a>
20+
</div>
21+
22+
23+
**OpenList-Mobile** is a mobile file server application based on [OpenList](https://github.com/OpenListTeam/OpenList), built with Flutter framework. Turn your phone into a powerful file server with LAN file sharing, remote access, and online management capabilities.
24+
25+
### Download & Installation
26+
27+
#### Stable Release
28+
- [📱 Latest Release](https://github.com/OpenListTeam/OpenList-Mobile/releases/latest) - Recommended
29+
30+
#### Development Build
31+
- [🔧 Development Build](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/build.yaml) - Latest Features
32+
33+
> **Auto-Update**: [GitHub Actions](https://github.com/OpenListTeam/OpenList-Mobile/actions/workflows/sync_openlist.yaml) automatically checks for the latest [OpenList](https://github.com/OpenListTeam/OpenList/releases) version twice daily (5 AM & 5 PM) and builds releases, ensuring always have access to the latest version.
34+
35+
### Supported Platforms
36+
- Android
37+
- iOS (Experimental, still in development)

0 commit comments

Comments
 (0)