docs: update readme

2022-09-09 14:35:05 +08:00 · 2022-09-09 14:35:05 +08:00 · 2505cb40ac
parent 4ec42a55d6
commit 2505cb40ac
2 changed files with 148 additions and 3 deletions
--- a/README.md
+++ b/README.md
@ -29,10 +29,53 @@

 ---

-[Contributors](./CONTRIBUTORS.md) | [Contributing](./CONTRIBUTING.md)
+English | [中文](./README_cn.md) | [Contributors](./CONTRIBUTORS.md) | [Contributing](./CONTRIBUTING.md)

-> ### New version is under development. Checkout [v2](https://github.com/alist-org/alist/tree/v2) branch for latest version.
-> Click [here](https://crwd.in/alist) to help translate.
+## Features
+
+- [x] Multiple storage
+    - [x] Local storage
+    - [x] [Aliyundrive](https://www.aliyundrive.com/)
+    - [x] OneDrive / Sharepoint ([global](https://www.office.com/), [cn](https://portal.partner.microsoftonline.cn),de,us)
+    - [x] [189cloud](https://cloud.189.cn) (Personal, Family)
+    - [x] [GoogleDrive](https://drive.google.com/)
+    - [x] [123pan](https://www.123pan.com/)
+    - [x] FTP / SFTP
+    - [x] [PikPak](https://www.mypikpak.com/)
+    - [x] [S3](https://aws.amazon.com/s3/)
+    - [x] [UPYUN Storage Service](https://www.upyun.com/products/file-storage)
+    - [x] WebDav(Support OneDrive/SharePoint without API)
+    - [x] Teambition([China](https://www.teambition.com/ ),[International](https://us.teambition.com/ ))
+    - [x] [Mediatrack](https://www.mediatrack.cn/)
+    - [x] [139yun](https://yun.139.com/) (Personal, Family)
+    - [x] [YandexDisk](https://disk.yandex.com/)
+    - [x] [BaiduNetdisk](http://pan.baidu.com/)
+    - [x] [Quark](https://pan.quark.cn)
+- [x] Easy to deploy and out-of-the-box
+- [x] File preview (PDF, markdown, code, plain text, ...)
+- [x] Image preview in gallery mode
+- [x] Video and audio preview, support lyrics and subtitles
+- [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 (see https://alist.nn.ci/guide/webdav.html for details)
+- [x] [Docker Deploy](https://hub.docker.com/r/xhofe/alist)
+- [x] Cloudflare workers proxy
+- [x] File/Folder package download
+- [x] Web upload(Can allow visitors to upload), delete, mkdir, rename, move and copy
+- [x] Offline download
+- [x] Copy files between two storage
+
+## Document
+
+<https://alist.nn.ci/>
+
+## Demo
+
+<https://pan.nn.ci>

 ## Discussion

--- a/README_cn.md
+++ b/README_cn.md
@ -0,0 +1,102 @@
+<div align="center">
+  <a href="https://alist.nn.ci"><img height="100px" alt="logo" src="https://cdn.jsdelivr.net/gh/alist-org/logo@main/logo.svg"/></a>
+  <p><em>🗂一个支持多存储的文件列表程序，使用 Gin 和 Solidjs。</em></p>
+  <a href="https://goreportcard.com/report/github.com/alist-org/alist/v3">
+    <img src="https://goreportcard.com/badge/github.com/alist-org/alist/v3" alt="latest version" />
+  </a>
+  <a href="https://github.com/Xhofe/alist/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/Xhofe/alist" alt="License" />
+  </a>
+  <a href="https://github.com/Xhofe/alist/discussions">
+    <img src="https://img.shields.io/github/discussions/Xhofe/alist?color=%23ED8936" alt="discussions" />
+  </a>
+  <a href="https://github.com/Xhofe/alist/actions?query=workflow%3ABuild">
+    <img src="https://img.shields.io/github/workflow/status/Xhofe/alist/build" alt="Build status" />
+  </a>
+  <a href="https://github.com/Xhofe/alist/releases">
+    <img src="https://img.shields.io/github/release/Xhofe/alist" alt="latest version" />
+  </a>
+  <a href="https://github.com/Xhofe/alist/releases">
+    <img src="https://img.shields.io/github/downloads/Xhofe/alist/total?color=%239F7AEA" alt="Downloads" />
+  </a>
+  <a title="Crowdin" target="_blank" href="https://crwd.in/alist">
+    <img src="https://badges.crowdin.net/alist/localized.svg">
+  </a>
+  <a href="https://pay.xhofe.top">
+    <img src="https://img.shields.io/badge/%24-sponsor-ff69b4.svg" alt="sponsor" />
+  </a>
+</div>
+
+---
+
+[English](./README.md) | 中文 | [Contributors](./CONTRIBUTORS.md) | [Contributing](./CONTRIBUTING.md)
+
+## Features
+
+- [x] 多种存储
+    - [x] 本地存储
+    - [x] [阿里云盘](https://www.aliyundrive.com/)
+    - [x] OneDrive / Sharepoint（[国际版](https://www.office.com/), [世纪互联](https://portal.partner.microsoftonline.cn),de,us）
+    - [x] [天翼云盘](https://cloud.189.cn) (个人云, 家庭云)
+    - [x] [GoogleDrive](https://drive.google.com/)
+    - [x] [123云盘](https://www.123pan.com/)
+    - [x] FTP / SFTP
+    - [x] [PikPak](https://www.mypikpak.com/)
+    - [x] [S3](https://aws.amazon.com/cn/s3/)
+    - [x] [又拍云对象存储](https://www.upyun.com/products/file-storage)
+    - [x] WebDav(支持无API的OneDrive/SharePoint)
+    - [x] Teambition（[中国](https://www.teambition.com/ )，[国际](https://us.teambition.com/ )）
+    - [x] [分秒帧](https://www.mediatrack.cn/)
+    - [x] [和彩云](https://yun.139.com/) (个人云, 家庭云)
+    - [x] [Yandex.Disk](https://disk.yandex.com/)
+    - [x] [百度网盘](http://pan.baidu.com/)
+    - [x] [夸克网盘](https://pan.quark.cn)
+- [x] 部署方便，开箱即用
+- [x] 文件预览（PDF、markdown、代码、纯文本……）
+- [x] 画廊模式下的图像预览
+- [x] 视频和音频预览，支持歌词和字幕
+- [x] Office 文档预览（docx、pptx、xlsx、...）
+- [x] `README.md` 预览渲染
+- [x] 文件永久链接复制和直接文件下载
+- [x] 黑暗模式
+- [x] 国际化
+- [x] 受保护的路由（密码保护和身份验证）
+- [x] WebDav (具体见 https://alist.nn.ci/zh/guide/webdav.html)
+- [x] [Docker 部署](https://hub.docker.com/r/xhofe/alist)
+- [x] Cloudflare workers 中转
+- [x] 文件/文件夹打包下载
+- [x] 网页上传(可以允许访客上传)，删除，新建文件夹，重命名，移动，复制
+- [x] 离线下载
+- [x] 跨存储复制文件
+
+## Document
+
+<https://alist.nn.ci/zh/>
+
+## Demo
+
+<https://pan.nn.ci>
+
+## Discussion
+
+一般问题请到[讨论论坛](https://github.com/Xhofe/alist/discussions) ，**issue仅针对错误报告和功能请求。**
+
+## Special sponsors
+- [找资源 - 阿里云盘资源搜索引擎](https://zhaoziyuan.la/)
+- [KinhDown 百度云盘不限速下载！永久免费！已稳定运行3年！非常可靠!](https://kinhdown.com/?Type=Tutorials)
+- [JetBrains: Essential tools for software developers and teams](https://www.jetbrains.com/)
+
+##  许可
+
+`AList` 是在 AGPL-3.0 许可下许可的开源软件。
+
+## 免责声明
+- 本程序为免费开源项目，旨在分享网盘文件，方便下载以及学习golang，使用时请遵守相关法律法规，请勿滥用；
+- 本程序通过调用官方sdk/接口实现，无破坏官方接口行为；
+- 本程序仅做302重定向/流量转发，不拦截、存储、篡改任何用户数据；
+- 在使用本程序之前，你应了解并承担相应的风险，包括但不限于账号被ban，下载限速等，与本程序无关；
+- 如有侵权，请通过[邮件](mailto:i@nn.ci)与我联系，会及时处理。
+
+---
+
+> [@博客](https://nn.ci/) · [@GitHub](https://github.com/Xhofe) · [@Telegram群](https://t.me/alist_chat) · [@QQ群](https://jq.qq.com/?_wv=1027&k=YJJj2Gwb)