diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..785ea445ef991185eacfd885255b32f1d1587c8c --- /dev/null +++ b/README.en.md @@ -0,0 +1,54 @@ +# Redisun + +Redisun is a Redis client based on [smart-socket](https://github.com/smartboot/smart-socket), designed to provide a simple and efficient way to connect and operate Redis. + +## Project Features + +- Built on smart-socket, delivering excellent performance. +- Provides clean and easy-to-use API interfaces. +- Supports asynchronous non-blocking communication mode. +- Easily integrated into Java-based projects. + +## Technology Stack + +- Java 1.8+ +- smart-socket +- Redis protocol support + +## Installation and Usage + +1. **Maven Dependency** + + ```xml + + tech.smartboot + redisun + 1.0.0 + + ``` + +2. **Quick Start** + + ```java + RedisunClient client = new RedisunClient("127.0.0.1", 6379); + client.connect(); + String response = client.sendCommand("SET", "key", "value"); + System.out.println(response); // Output: OK + ``` + +## Developer Information + +- **Author**: 三刀 (Seer) +- **Contact**: zhengjunweimail@163.com +- **Organization**: [SmartBoot](https://gitee.com/smartboot) + +## License + +Redisun is open-sourced under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0.txt). + +## Repository Links + +- Gitee: [https://gitee.com/smartboot/redisun](https://gitee.com/smartboot/redisun) +- GitHub: [https://github.com/smartboot/redisun](https://github.com/smartboot/redisun) + +Feel free to submit PRs or raise issues to help us improve the project! \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..260c1dfac5324fca9300f29ee8aea2e2a960a41b --- /dev/null +++ b/README.md @@ -0,0 +1,54 @@ +# Redisun + +Redisun 是一个基于 [smart-socket](https://github.com/smartboot/smart-socket) 的 Redis 客户端,旨在为 Redis 提供简单高效的连接和操作方式。 + +## 项目特性 + +- 基于 smart-socket 构建,性能优异。 +- 提供简洁易用的 API 接口。 +- 支持异步非阻塞通信模式。 +- 易于集成到基于 Java 的项目中。 + +## 技术栈 + +- Java 1.8+ +- smart-socket +- Redis 协议支持 + +## 安装与使用 + +1. **Maven 依赖** + + ```xml + + tech.smartboot + redisun + 1.0.0 + + ``` + +2. **快速开始** + + ```java + RedisunClient client = new RedisunClient("127.0.0.1", 6379); + client.connect(); + String response = client.sendCommand("SET", "key", "value"); + System.out.println(response); // 输出: OK + ``` + +## 开发者信息 + +- **作者**: 三刀 (Seer) +- **联系方式**: zhengjunweimail@163.com +- **组织**: [SmartBoot](https://gitee.com/smartboot) + +## 协议 + +Redisun 使用 [Apache 2.0 协议](http://www.apache.org/licenses/LICENSE-2.0.txt) 开源。 + +## 仓库地址 + +- Gitee: [https://gitee.com/smartboot/redisun](https://gitee.com/smartboot/redisun) +- GitHub: [https://github.com/smartboot/redisun](https://github.com/smartboot/redisun) + +欢迎提交 PR 或提出 Issue 来帮助我们改进项目! \ No newline at end of file