diff --git a/README.md b/README.md index 5cee6ff882..f2f18ae941 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,37 @@ 阿里云盘 WebDav 服务 +## Installation + +You can download prebuilt binaries from [GitHub Releases](https://github.com/messense/aliyundrive-webdav/releases). +Or install it from PyPI: + +```bash +pip install aliyundrive-webdav +``` + +## Usage + +```bash +aliyundrive-webdav --help +aliyundrive-webdav 0.1.0 + +USAGE: + aliyundrive-webdav [FLAGS] [OPTIONS] --refresh-token + +FLAGS: + -I, --auto-index Automatically generate index.html + -h, --help Prints help information + -V, --version Prints version information + +OPTIONS: + -W, --auth-password WebDav authentication password + -U, --auth-user WebDav authentication username + --host Listen host [default: 127.0.0.1] + -p, --port Listen port [default: 8080] + -r, --refresh-token Aliyun drive refresh token [env: REFRESH_TOKEN=] +``` + ## License This work is released under the MIT license. A copy of the license is provided in the [LICENSE](../LICENSE) file.