📝 update readme doc

Author: ccoderJava

README-CN.md

@@ -0,0 +1,121 @@
+## ccoder-ufs
+
+
+[![](https://img.shields.io/github/issues/ccoderJava/ccoder-ufs.svg)](https://github.com/ccoderJava/ccoder-ufs/issues)
+[![](https://img.shields.io/github/forks/ccoderJava/ccoder-ufs.svg)](https://github.com/ccoderJava/ccoder-ufs/network)
+[![](https://img.shields.io/github/stars/ccoderJava/ccoder-ufs.svg)](https://github.com/ccoderJava/ccoder-ufs/stargazers)
+[![](https://travis-ci.org/ccoderJava/ccoder-ufs.svg?branch=master)](https://travis-ci.org/ccoderJava/ccoder-ufs)
+[![](https://img.shields.io/github/release/ccoderJava/ccoder-ufs.svg)](https://github.com/ccoderJava/ccoder-ufs/releases)
+[![jaywcjlove/sb](https://jaywcjlove.github.io/sb/lang/chinese.svg)](README-CN.md)
+
+
+OSS对象存储(Object Storage Service） 集成对接aliyun、qiniu、huawei、tencent等云存储，提供统一抽象的ufs服务
+
+## 1. Introduction
+
+ccoder-ufs is an OSS(Object Storage Service） integration and abstraction for aliyun、qiniu、huawei、tencent and other cloud storage, providing unified abstraction of ufs services
+
+## 2. Features
+
+- [x] Unified abstraction of OSS
+- [x] Unified abstraction of OSS file
+- [x] Unified abstraction of OSS file input stream
+- [x] Unified abstraction of OSS file output stream
+- [x] Unified abstraction of OSS file meta
+- [x] Unified abstraction of OSS file meta list
+- [x] Unified abstraction of OSS file meta iterator
+- [x] Unified abstraction of OSS file meta page
+
+## 3. Usage
+
+### 3.1. Maven
+
+```xml
+<dependency>
+    <groupId>com.ccoder</groupId>
+    <artifactId>ccoder-ufs</artifactId>
+    <version>1.0.0</version>
+</dependency>
+```
+
+### 3.2. Gradle
+
+```groovy
+compile 'com.ccoder:ccoder-ufs:1.0.0'
+```
+
+## 4. License
+
+[Apache License 2.0](LICENSE)
+
+## 5. Contact
+
+- [ccoderJava](https:://github.com/ccoderJava)
+- [wechat](聪聪碎碎念)
+- [email](mailto:congccoder@gmail.com)
+- [blog](https://blog.csdn.net/ccoderJava)
+- [juejin](https://juejin.cn/user/3737995267030030)
+- [segmentfault](https://segmentfault.com/u/cong_ccoder)
+
+## 6. Donate
+
+If you find this project useful, you can buy me a cup of coffee.
+
+[![](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/ccoderJava)
+
+## 7. Thanks
+
+- [ccoder-oss](xxx)
+
+## 8. ChangeLog
+
+- 1.0.0
+    - Initial release
+    - Support aliyun、qiniu、huawei、tencent and other cloud storage
+    - Support unified abstraction of OSS
+    - Support unified abstraction of OSS file
+
+## 9. FAQ
+
+- Q: xxx
+- A: xxx
+- Q: xxx
+- A: xxx
+
+## 10. TODO
+
+- [ ] xxx
+- [ ] xxx
+
+## 11. Contributing
+
+- Fork it
+- Create your feature branch (git checkout -b my-new-feature)
+- Commit your changes (git commit -am 'Add some feature')
+- Push to the branch (git push origin my-new-feature)
+- Create new Pull Request
+- Thanks!
+
+## 12. Contributors
+
+- [ccoderJava](https://github.com/ccoderJava)
+
+## 13. Related Projects
+
+- [xxx](xxx)
+
+## 14. References
+
+- [xxx](xxx)
+- [xxx](xxx)
+
+## 15. Other
+
+- [xxx](xxx)
+- [xxx](xxx)
+- [xxx](xxx)
+
+## 16. Appendix
+
+- [xxx](xxx)
+- [xxx](xxx)

README.md

@@ -11,5 +11,111 @@
 
 OSS对象存储(Object Storage Service） 集成对接aliyun、qiniu、huawei、tencent等云存储，提供统一抽象的ufs服务
 
-### 可视化工具
-ossbrowser
+## 1. Introduction
+
+ccoder-ufs is an OSS(Object Storage Service） integration and abstraction for aliyun、qiniu、huawei、tencent and other cloud storage, providing unified abstraction of ufs services
+
+## 2. Features
+
+- [x] Unified abstraction of OSS
+- [x] Unified abstraction of OSS file
+- [x] Unified abstraction of OSS file input stream
+- [x] Unified abstraction of OSS file output stream
+- [x] Unified abstraction of OSS file meta
+- [x] Unified abstraction of OSS file meta list
+- [x] Unified abstraction of OSS file meta iterator
+- [x] Unified abstraction of OSS file meta page
+
+## 3. Usage
+
+### 3.1. Maven
+
+```xml
+<dependency>
+    <groupId>com.ccoder</groupId>
+    <artifactId>ccoder-ufs</artifactId>
+    <version>1.0.0</version>
+</dependency>
+```
+
+### 3.2. Gradle
+
+```groovy
+compile 'com.ccoder:ccoder-ufs:1.0.0'
+```
+
+## 4. License
+
+[Apache License 2.0](LICENSE)
+
+## 5. Contact
+
+- [ccoderJava](https:://github.com/ccoderJava)
+- [wechat](聪聪碎碎念)
+- [email](mailto:congccoder@gmail.com)
+- [blog](https://blog.csdn.net/ccoderJava)
+- [juejin](https://juejin.cn/user/3737995267030030)
+- [segmentfault](https://segmentfault.com/u/cong_ccoder)
+
+## 6. Donate
+
+If you find this project useful, you can buy me a cup of coffee.
+
+[![](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.me/ccoderJava)
+
+## 7. Thanks
+
+- [ccoder-oss](xxx)
+
+## 8. ChangeLog
+
+- 1.0.0
+    - Initial release
+    - Support aliyun、qiniu、huawei、tencent and other cloud storage
+    - Support unified abstraction of OSS
+    - Support unified abstraction of OSS file
+
+## 9. FAQ
+
+- Q: xxx
+- A: xxx
+- Q: xxx
+- A: xxx
+
+## 10. TODO
+
+- [ ] xxx
+- [ ] xxx
+
+## 11. Contributing
+
+- Fork it
+- Create your feature branch (git checkout -b my-new-feature)
+- Commit your changes (git commit -am 'Add some feature')
+- Push to the branch (git push origin my-new-feature)
+- Create new Pull Request
+- Thanks!
+
+## 12. Contributors
+
+- [ccoderJava](https://github.com/ccoderJava)
+
+## 13. Related Projects
+
+- [xxx](xxx)
+
+## 14. References
+
+- [xxx](xxx)
+- [xxx](xxx)
+
+## 15. Other
+
+- [xxx](xxx)
+- [xxx](xxx)
+- [xxx](xxx)
+
+## 16. Appendix
+
+- [xxx](xxx)
+- [xxx](xxx)