diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index ec815e4..f7ca830 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -36,6 +36,7 @@ export default withMermaid( { text: '快速开始', link: '/guide/getting-started' }, { text: '操作指南', link: '/guide/operating_guide' }, { text: '许可证结构与验证(客户端要点)', link: '/guide/license-token-structure' }, + { text: '客户端 SDK', link: '/guide/sdk' }, { text: '商业价值', link: '/guide/business_value' }, { text: '接口文档', link: '/guide/api' }, { text: '社区发展策略', link: '/guide/community_strategy' } @@ -61,6 +62,7 @@ export default withMermaid( { text: 'Introduction', link: '/en/guide/' }, { text: 'Getting Started', link: '/en/guide/getting-started' }, { text: 'Operating Guide', link: '/en/guide/operating_guide' }, + { text: 'Client SDK', link: '/en/guide/sdk' }, { text: 'Business Value', link: '/en/guide/business_value' }, { text: 'License Structure & Validation', link: '/en/guide/license-token-structure' }, { text: 'API Reference', link: '/en/guide/api' }, @@ -87,6 +89,7 @@ export default withMermaid( { text: 'Introduction', link: '/guide/' }, { text: 'Getting Started', link: '/guide/getting-started' }, { text: 'Operating Guide', link: '/guide/operating_guide' }, + { text: 'Client SDK | 客户端 SDK', link: '/guide/sdk' }, { text: 'License Token Structure', link: '/guide/license-token-structure' }, { text: 'API 文档 | API Reference', link: '/guide/api' } ] diff --git a/docs/en/guide/sdk.md b/docs/en/guide/sdk.md new file mode 100644 index 0000000..3523aa5 --- /dev/null +++ b/docs/en/guide/sdk.md @@ -0,0 +1,19 @@ +# Client SDK + +The client SDK packages the license parsing, signature verification, and runtime health checks that every edge/desktop/embedded client needs so you don’t have to re-implement the security workflow in multiple codebases. + +## Quick Links + +- GitHub repository (README + samples + API docs): [https://github.com/cedar-v/license-manager-sdk-go](https://github.com/cedar-v/license-manager-sdk-go) +- License structure reference: [`/en/guide/license-token-structure`](/en/guide/license-token-structure) + +> All hands-on content (installation, configuration, examples, changelog) lives inside the repository README so there is only one source of truth. + +## When to Use + +- Boot-time validation on standalone or edge deployments +- Hybrid setups that exchange heartbeats with the License Manager service +- Clients that need consistent error codes and logging for license enforcement + +Need a feature or found an issue? Open a discussion or issue directly in the repository to keep the conversation close to the source. + diff --git a/docs/guide/sdk.md b/docs/guide/sdk.md new file mode 100644 index 0000000..8355ced --- /dev/null +++ b/docs/guide/sdk.md @@ -0,0 +1,18 @@ +# 客户端 SDK + +License Manager 提供可复用的客户端 SDK,涵盖许可证解析、验签与运行时校验等常见能力,避免你在各个项目中反复实现安全细节。 + +## 快速入口 + +- GitHub 仓库(含 README、示例与 API 说明):[https://github.com/cedar-v/license-manager-sdk-go](https://github.com/cedar-v/license-manager-sdk-go) +- 许可证结构参考:[`/guide/license-token-structure`](/guide/license-token-structure) + +> SDK 具体使用方法(安装、配置、代码示例等)请直接参考仓库 README;这里只保留索引,确保信息只维护一份。 + +## 典型使用场景 + +- 桌面/边缘客户端在启动阶段校验许可证合法性 +- 需要与 License Manager 云端做心跳或续期的混合部署 +- 通过统一错误码与日志追踪客户端授权状态 + +如需在社群反馈功能需求或提 Issue,也欢迎直接在仓库参与讨论。 \ No newline at end of file