From 308a86c36e43c507563c442757e4378c19cc821d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BE=AE=E5=87=89?= <927625802@qq.com> Date: Thu, 2 Dec 2021 22:38:18 +0800 Subject: [PATCH] :memo: update readme --- README.md | 60 ++++++++++++++++++++++++++++++++-------------------- README_cn.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 96 insertions(+), 23 deletions(-) mode change 100644 => 100755 README.md create mode 100644 README_cn.md diff --git a/README.md b/README.md old mode 100644 new mode 100755 index 90bb656b..90d1c289 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ -

Alist

-

+

+

Alist

+

A file list program that supports multiple storage, powered by gin and React.

Release version Build status Downloads @@ -7,40 +8,53 @@ donate -

+
+ --- -### 这是什么? +English | [中文](./README_cn.md) -一款支持多种存储的目录文件列表程序,后端基于`gin`,前端使用`react`。 +## Features -### 前端项目地址 +- [x] multiple storage + - [x] Local storage + - [x] [aliyundrive](https://www.aliyundrive.com/) + - [x] OneDrive([global](https://www.office.com/), [cn](https://portal.partner.microsoftonline.cn),de,us) + - [x] [189cloud]([https://cloud.189.cn](https://cloud.189.cn/web/main/file/folder/-11)) + - [x] [GoogleDrive](https://drive.google.com/) + - [x] [123pan](https://www.123pan.com/) + - [x] [lanzou](https://pc.woozooo.com/) +- [x] File preview (PDF, markdown, code, plain text, ...) +- [x] Image preview in gallery mode +- [x] Video and audio preview (mp4, mp3, ...) +- [x] Office documents preview (docx, pptx, xlsx, ...) +- [x] `README.md` preview rendering +- [x] File permalink copy and direct file download +- [x] Dark mode +- [x] I18n +- [x] Protected routes (password protection and authentication) +- [x] WebDav (readonly) +- [x] [Docker Deploy](https://hub.docker.com/r/xhofe/alist) -- https://github.com/Xhofe/alist-web +## Discussion -### 演示地址 +Please go to our [discussion forum](https://github.com/Xhofe/alist/discussions) for general questions, **issues are for bug reports only.** -- https://alist.nn.ci +## Demo -### 预览 +Available at: . - +![demo](https://store.heytapimage.com/cdo-portal/feedback/202112/02/14803f03878e0c6cc863bae95bc2ae0c.png) -### 支持的存储 +## Document -- 本地存储 -- 阿里云盘 -- Onedrive/世纪互联 -- 天翼云盘 -- GoogleDrive -- 123pan -- ... + -### 如何使用 +## License -- https://alist-doc.nn.ci/ +The `AList` is open-source software licensed under the MIT license. -### License +--- -The `AList` is open-source software licensed under the MIT license. \ No newline at end of file +> [@Blog](https://www.nn.ci/) · [@GitHub](https://github.com/Xhofe) \ No newline at end of file diff --git a/README_cn.md b/README_cn.md new file mode 100644 index 00000000..e07d3c92 --- /dev/null +++ b/README_cn.md @@ -0,0 +1,59 @@ +
+

Alist

+

一个支持多存储的文件列表程序,使用 gin 和 React 。

+ 发布版本 + Build status + 下载 + License + + donate + +
+ +--- + +[English](./README.md) | 中文 + +## 支持 + +- [x] 多种存储 + - [x] 本地存储 + - [x] [aliyundrive](https://www.aliyundrive.com/) + - [x] OneDrive([国际版](https://www.office.com/), [世纪互联](https://portal.partner.microsoftonline.cn),de,us) + - [x] [天翼云盘]([https://cloud.189.cn](https://cloud.189.cn/web/main/file/folder/-11)) + - [x] [GoogleDrive](https://drive.google.com/) + - [x] [123云盘](https://www.123pan.com/) + - [x] [蓝奏云](https://pc.woozooo.com/) +- [x] 文件预览(PDF、markdown、代码、纯文本……) +- [x] 画廊模式下的图像预览 +- [x] 视频和音频预览(mp4、mp3 等) +- [x] Office 文档预览(docx、pptx、xlsx、...) +- [x] `README.md` 预览渲染 +- [x] 文件永久链接复制和直接文件下载 +- [x] 黑暗模式 +- [x] 国际化 +- [x] 受保护的路由(密码保护和身份验证) +- [x] WebDav(只读) +- [x] [Docker 部署](https://hub.docker.com/r/xhofe/alist) + +## 讨论 + +一般问题请到[讨论论坛](https://github.com/Xhofe/alist/discussions) ,**issue仅针对错误报告。** + +## 演示 + +。 + +![演示](https://store.heytapimage.com/cdo-portal/feedback/202112/02/14803f03878e0c6cc863bae95bc2ae0c.png) + +## 文档 + + + +## 许可 + +`AList` 是在 MIT 许可下许可的开源软件。 + +--- + +> [@Blog](https://www.nn.ci/) · [@GitHub](https://github.com/Xhofe) \ No newline at end of file