浏览代码

add README

joe 4 年之前
父节点
当前提交
9bf8517b25
共有 1 个文件被更改,包括 26 次插入0 次删除
  1. 26 0
      README.cn.md

+ 26 - 0
README.cn.md

@@ -0,0 +1,26 @@
+# nnet
+
+简单封装的网络库, 支持 TCP, Websocket
+
+不支持常见的 Encoder/Decoder, Middleware 等组件, 降低复杂度.
+
+## How to use
+
+see sample/
+
+## TODO
+
+- 支持内置默认的 listener
+- 根据实际使用添加更方便使用的高层函数
+- 支持流量等状态统计
+
+## NO PLAN
+
+- 黑白名单
+- TLS
+
+*以上应使用前置代理*
+
+## License
+
+[The 3-Clause BSD License](https://opensource.org/licenses/BSD-3-Clause)