Skip to content

Commit

Permalink
modify readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yangziwen committed Jul 17, 2021
1 parent d78bd65 commit 8628002
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
## zy-ftp

[Chinese Doc](https://github.com/yangziwen/zy-ftp/blob/master/README_CN.md)
#### Introduction
### Introduction
A netty based ftp server

#### Feature
### Feature
* Implements most frequently used ftp commands ([see details](https://github.com/yangziwen/zy-ftp/tree/master/src/main/java/io/github/yangziwen/zyftp/command/impl))
* Support configurations of user access priviledge and file transfer rate limit ([see options](https://github.com/yangziwen/zy-ftp/blob/master/conf/server.config))
* Both active mode and passive mode are supported under cleartext transmission
* Only passive mode is supported when transfer data over TLS
* Only passive mode is supported when running inside a docker container

#### Usage
### Usage
* Running an embedded server
1. Import the dependency
```xml
Expand Down
8 changes: 5 additions & 3 deletions README_CN.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
## zy-ftp
基于netty实现的ftp服务器。

#### 特性
### 简介
一款基于netty实现的ftp服务器。

### 特性
* 实现了ftp服务端常用的大部分命令,详情[请见代码](https://github.com/yangziwen/zy-ftp/tree/master/src/main/java/io/github/yangziwen/zyftp/command/impl)
* 支持配置用户访问文件权限、文件传输限速等,详情[请见配置](https://github.com/yangziwen/zy-ftp/blob/master/conf/server.config)
* 不加密的传输方式下支持主动、被动模式
* 加密的传输方式下(FTP over TLS),仅支持被动模式
* 运行于docker环境时,仅支持被动模式

#### 使用
### 使用
* 内嵌在程序中运行
1. 引入依赖
```xml
Expand Down

0 comments on commit 8628002

Please sign in to comment.