extern/frp
1
1
Fork 0
mirror of https://github.com/fatedier/frp.git synced 2024-12-13 10:11:04 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: update

Browse Source
This commit is contained in:
fatedier 2016-08-21 00:52:15 +08:00
parent 603d7df49a
commit 5079bf01fd
2 changed files with 21 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -329,7 +329,9 @@ If `host_header_rewrite` is specified, the Host header will be rewritten to matc
Interested in getting involved? We would like to help you! Interested in getting involved? We would like to help you!
* Take a look at our [issues list](https://github.com/fatedier/frp/issues) and consider submitting a patch to **dev branch**. * Take a look at our [issues list](https://github.com/fatedier/frp/issues) and consider sending a Pull Request to **dev branch**.
* If you want to add a new feature, please create an issue first to describe the new feature, as well as the implementation approach. Once a proposal is accepted, create an implementation of the new features and submit it as a pull request.
* Sorry for my poor english and improvement for this document is welcome even some typo fix.
* If you have some wanderful ideas, send email to fatedier@gmail.com. * If you have some wanderful ideas, send email to fatedier@gmail.com.
**Note: We prefer you to give your advise in [issues](https://github.com/fatedier/frp/issues), so others with a same question can search it quickly and we don't need to answer them repeatly.** **Note: We prefer you to give your advise in [issues](https://github.com/fatedier/frp/issues), so others with a same question can search it quickly and we don't need to answer them repeatly.**
@ -338,5 +340,8 @@ Interested in getting involved? We would like to help you!
* [fatedier](https://github.com/fatedier) * [fatedier](https://github.com/fatedier)
* [Hurricanezwf](https://github.com/Hurricanezwf) * [Hurricanezwf](https://github.com/Hurricanezwf)
* [vashstorm](https://github.com/vashstorm) * [Pan Hao](https://github.com/vashstorm)
* [maodanp](https://github.com/maodanp) * [Danping Mao](https://github.com/maodanp)
* [Eric Larssen](https://github.com/ericlarssen)
* [Damon Zhao](https://github.com/se77en)
* [Manfred Touron](https://github.com/moul)

20
README_zh.md
View File

@ -24,7 +24,7 @@ frp 是一个高性能的反向代理应用，可以帮助您轻松地进行内
* [连接池](#连接池) * [连接池](#连接池)
* [修改 Host Header](#修改-host-header) * [修改 Host Header](#修改-host-header)
* [开发计划](#开发计划) * [开发计划](#开发计划)
* [贡献代码](#贡献代码) * [为 frp 做贡献](#为-frp-做贡献)
* [贡献者](#贡献者) * [贡献者](#贡献者)
## frp 的作用 ## frp 的作用
@ -332,13 +332,16 @@ host_header_rewrite = dev.yourdomain.com
* frpc 完全控制模式，通过 dashboard 对 frpc 进行在线操作。 * frpc 完全控制模式，通过 dashboard 对 frpc 进行在线操作。
* 支持 udp 打洞的方式，提供两边内网机器直接通信，流量不经过服务器转发。 * 支持 udp 打洞的方式，提供两边内网机器直接通信，流量不经过服务器转发。
## 贡献代码 ## 为 frp 做贡献
如果您对这个项目感兴趣，我们非常欢迎您参与其中！ frp 是一个免费且开源的项目，我们欢迎任何人为其开发和进步贡献力量。
* 如果您需要提交问题，可以通过 [issues](https://github.com/fatedier/frp/issues) 来反馈。 * 在使用过程中出现任何问题，可以通过 [issues](https://github.com/fatedier/frp/issues) 来反馈。
* Bug 的修复可以直接提交 Pull Request 到 dev 分支。
* 如果是增加新的功能特性，请先创建一个 issue 并做简单描述以及大致的实现方法，提议被采纳后，就可以创建一个实现新特性的 Pull Request。
* 欢迎对说明文档做出改善，帮助更多的人使用 frp，特别是英文文档。
* 贡献代码请提交 PR 至 dev 分支，master 分支仅用于发布稳定可用版本。 * 贡献代码请提交 PR 至 dev 分支，master 分支仅用于发布稳定可用版本。
* 如果您有新的功能需求，可以反馈至 fatedier@gmail.com 共同讨论。 * 如果你有任何其他方面的问题，欢迎反馈至 fatedier@gmail.com 共同交流。
**提醒：和项目相关的问题最好在 [issues](https://github.com/fatedier/frp/issues) 中反馈，这样方便其他有类似问题的人可以快速查找解决方法，并且也避免了我们重复回答一些问题。** **提醒：和项目相关的问题最好在 [issues](https://github.com/fatedier/frp/issues) 中反馈，这样方便其他有类似问题的人可以快速查找解决方法，并且也避免了我们重复回答一些问题。**
@ -346,5 +349,8 @@ host_header_rewrite = dev.yourdomain.com
* [fatedier](https://github.com/fatedier) * [fatedier](https://github.com/fatedier)
* [Hurricanezwf](https://github.com/Hurricanezwf) * [Hurricanezwf](https://github.com/Hurricanezwf)
* [vashstorm](https://github.com/vashstorm) * [Pan Hao](https://github.com/vashstorm)
* [maodanp](https://github.com/maodanp) * [Danping Mao](https://github.com/maodanp)
* [Eric Larssen](https://github.com/ericlarssen)
* [Damon Zhao](https://github.com/se77en)
* [Manfred Touron](https://github.com/moul)