chore(readme): update readme

This commit is contained in:
hexxa 2021-08-30 20:50:02 +08:00 committed by Hexxa
parent 322734932c
commit 90e8ce9540
3 changed files with 54 additions and 30 deletions

View file

@ -22,17 +22,29 @@
Choose Language: English | [简体中文](./docs/README_zh-cn.md) Choose Language: English | [简体中文](./docs/README_zh-cn.md)
## Main Features ## Features
- File Management
- No client needed
- No limit on file size
- Stop and resume uploading/downloading in the middle
- Share directories to others
- Upload hundreds of files at once
- Steaming uploading: make it work behind CDN or reverse proxy
- Files can also be managed from OS
- User Management
- Support multiple users
- User home directory
- Per-user download & upload speed limiting
- Per-user space quota
- MISC
- Adaptive UI
- Cross-platform: support Linux, Mac and Windows
- Sharing and accessing from different devices (Adaptive UI)
- Be compatible with Linux, Mac and Windows
- Stopping and resuming uploading/downloading
- Do uploading and downloading in web browser
- Manage files through browser or OS
## Quick Start ## Quick Start
### Run in Docker ### Run in Docker (Recommended)
Following will start a `quickshare` docker and listen to `8686` port. Following will start a `quickshare` docker and listen to `8686` port.
@ -40,12 +52,13 @@ Then you can open `http://127.0.0.1:8686` and log in with user name `qs` and pas
``` ```
docker run \ docker run \
--name quickshare \ --name quickshare \
-d -p 8686:8686 \ -d -p 8686:8686 \
-v `pwd`/quickshare/root:/quickshare/root \ -v `pwd`/quickshare/root:/quickshare/root \
-e DEFAULTADMIN=qs \ -e DEFAULTADMIN=qs \
-e DEFAULTADMINPWD=1234 \ -e DEFAULTADMINPWD=1234 \
hexxa/quickshare --user $(id -u):$(id -g) \
hexxa/quickshare
``` ```
- `DEFAULTADMIN` is the default user name - `DEFAULTADMIN` is the default user name
@ -54,7 +67,7 @@ docker run \
### Run from source code ### Run from source code
Before start, please confirm Go/Golang (>1.15), Node.js and Yarn are installed on your machine. Before start, please confirm that Go/Golang (>=1.15), Node.js and Yarn are installed on your machine.
``` ```
# clone this repo # clone this repo

View file

@ -24,15 +24,25 @@
## 主要功能 ## 主要功能
- 在多个设备之间共享和存取文件 (自适应 UI) - 文件管理
- 兼容 Linux, Mac 和 Windows - 无需客户端
- 上传下载都支持断点续传 - 无文件大小限制
- 在 Web 浏览器 中完成上传下载 - 上传下载的断点续传
- 通过浏览器或者OS管理文件 - 将目录共享他人
- 一次上传上百个文件
- 流式上传: 使它可工作在 CDN 或 反向代理 之后
- 也可通过操作系统管理文件
- 用户管理
- 支持多用户
- 用户home目录
- 用户级别的上传下载速度限制
- 用户级别的空间限制
- 其他
- 自适应UI
- 跨平台: 支持Linux, Mac and Windows
## 快速开始 ## 快速开始
### 在Docker内运行 ### 通过Docker运行 (推荐)
下面会启动一个 `quickshare` docker 并监听 `8686` 端口. 下面会启动一个 `quickshare` docker 并监听 `8686` 端口.
@ -40,12 +50,13 @@
``` ```
docker run \ docker run \
--name quickshare \ --name quickshare \
-d -p 8686:8686 \ -d -p 8686:8686 \
-v `pwd`/quickshare/root:/quickshare/root \ -v `pwd`/quickshare/root:/quickshare/root \
-e DEFAULTADMIN=qs \ -e DEFAULTADMIN=qs \
-e DEFAULTADMINPWD=1234 \ -e DEFAULTADMINPWD=1234 \
hexxa/quickshare --user $(id -u):$(id -g) \
hexxa/quickshare
``` ```
- `DEFAULTADMIN` 是默认的用户名 - `DEFAULTADMIN` 是默认的用户名
@ -54,7 +65,7 @@ docker run \
### 运行源代码 ### 运行源代码
在开始之前, 请确认 Go/Golang (>1.15), Node.js 和 Yarn 已经安装在您的机器. 在开始之前, 请确认 Go/Golang (>=1.15), Node.js 和 Yarn 已经安装在您的机器.
``` ```
# clone this repo # clone this repo

View file

@ -3,7 +3,7 @@ import * as ReactDOM from "react-dom";
import { List, Map } from "immutable"; import { List, Map } from "immutable";
import FileSize from "filesize"; import FileSize from "filesize";
import { RiFolder2Fill } from "@react-icons/all-files/ri/RiFolder2Fill"; import { RiFolder2Fill } from "@react-icons/all-files/ri/RiFolder2Fill";
import { RiFileList2Fill } from "@react-icons/all-files/ri/RiFileList2Fill"; import { RiHomeSmileFill } from "@react-icons/all-files/ri/RiHomeSmileFill";
import { RiFile2Fill } from "@react-icons/all-files/ri/RiFile2Fill"; import { RiFile2Fill } from "@react-icons/all-files/ri/RiFile2Fill";
import { RiShareBoxLine } from "@react-icons/all-files/ri/RiShareBoxLine"; import { RiShareBoxLine } from "@react-icons/all-files/ri/RiShareBoxLine";
import { RiFolderSharedFill } from "@react-icons/all-files/ri/RiFolderSharedFill"; import { RiFolderSharedFill } from "@react-icons/all-files/ri/RiFolderSharedFill";
@ -557,7 +557,7 @@ export class Browser extends React.Component<Props, State, {}> {
<span className="padding-m"> <span className="padding-m">
<Flexbox <Flexbox
children={List([ children={List([
<RiFileList2Fill <RiHomeSmileFill
size="3rem" size="3rem"
className="margin-r-m black-font" className="margin-r-m black-font"
/>, />,