From 08df8cebb0f1d8359c0c3ca5237e8143e4b22828 Mon Sep 17 00:00:00 2001 From: ysicing Date: Tue, 24 Dec 2024 14:08:14 +0800 Subject: [PATCH] * [docs] deprecate old client and update documentation accordingly --- README.md | 6 +++--- buildin/README.md | 9 +++++++++ buildin/zentao.go | 2 ++ 3 files changed, 14 insertions(+), 3 deletions(-) create mode 100644 buildin/README.md diff --git a/README.md b/README.md index 2f3e7a3..9cb5222 100644 --- a/README.md +++ b/README.md @@ -147,11 +147,11 @@ import "github.com/easysoft/go-zentao/v21/zentao" ### 支持PathINFO/Get内置页面接口 -> 有限支持, 是对Restful API的拓展 +> 暂无计划支持 -## 测试账号 +## 本地测试 -> 推荐本地部署 +> 推荐本地部署, 示例为docker compose部署 ```bash #部署方式: diff --git a/buildin/README.md b/buildin/README.md new file mode 100644 index 0000000..959db9c --- /dev/null +++ b/buildin/README.md @@ -0,0 +1,9 @@ +# buildin + +> Deprecated: please use zentao.NewBasicAuthClient instead + +## Usage + +```bash +go get github.com/easysoft/go-zentao/v21/buildin +``` diff --git a/buildin/zentao.go b/buildin/zentao.go index 4584744..8e452f3 100644 --- a/buildin/zentao.go +++ b/buildin/zentao.go @@ -65,6 +65,8 @@ type Client struct { Login *LoginService } +// Deprecated: please use zentao.NewBasicAuthClient instead +// NewBasicAuthClient 使用用户名和密码创建一个客户端 func NewBasicAuthClient(username, password string, options ...ClientOptionFunc) (*Client, error) { client, err := newClient(options...) if err != nil {