From 0bb7754f5b9292899bb803f7e4794ec7d2c1d42d Mon Sep 17 00:00:00 2001
From: MingXiLiu <zmszm666@163.com>
Date: Thu, 7 Dec 2023 10:17:08 +0800
Subject: [PATCH] docs: update README.md

---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a83c4db
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+# laravel-JsTan
+
+## 简介
+
+laravel-JsTan 是基于[聚水潭 sdk（2.0）](https://github.com/zmoyi/JsTan)的 Laravel 聚水潭 SDK，支持laravel9.0以上版本。
+
+## 特点
+
+- 基于laravel10开发，支持laravel9以上版本
+
+## 安装
+
+```
+composer require zmoyi/laravel-JsTan
+```
+
+## 使用
+
+### 发布配置文件
+
+```
+php artisan vendor:publish --tag=laravel-jsTan
+```
+
+### 使用示例
+
+```php
+use JsTan\Route;
+use LaravelJsTan\Facades\JsTan;
+
+/**
+* ...
+**/
+
+$authUrl = JsTan::Client()->createAuthUrl();
+        $response = JsTan::Client()->request(
+            Route::QUERY_SHOPS,[
+                'page_index' => 1,
+                'page_size' => 10
+            ]
+        );
+```
+
+## 注意事项
+- 遇到问题请先查阅聚水潭文档，如果文档中没有说明，请在此处提 issue
+- 聚水潭 sdk 文档地址：https://github.com/zmoyi/JsTan
+- 聚水潭 文档说明：https://openweb.jushuitan.com/doc
+- 聚水潭 sdk 文档示例：https://github.com/zmoyi/JsTan/blob/main/tests/MyClientTest.php
+
+## 开源协议
+
+[MIT]()
+## 版权信息
+
+MIT © [zmoyi](https://github.com/zmoyi)
+
+## 捐赠
+如果您觉得这个项目帮助到了您，可以请作者喝杯咖啡表示鼓励。