Skip to content

docs: improve pkg.go.dev SDK docs #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
strahe merged 1 commit into from
Jun 27, 2026
Merged

docs: improve pkg.go.dev SDK docs #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![CI](https://github.com/strahe/bwh/actions/workflows/ci.yml/badge.svg)](https://github.com/strahe/bwh/actions/workflows/ci.yml)
[![Go Report Card](https://goreportcard.com/badge/github.com/strahe/bwh)](https://goreportcard.com/report/github.com/strahe/bwh)
[![Go Reference](https://pkg.go.dev/badge/github.com/strahe/bwh/pkg/client.svg)](https://pkg.go.dev/github.com/strahe/bwh/pkg/client)
[![Release](https://img.shields.io/github/v/release/strahe/bwh)](https://github.com/strahe/bwh/releases)

> **English | [中文](README.zh.md)**
Expand All @@ -19,7 +20,7 @@ Prerequisites: Go 1.24+; KiwiVM VEID and API key.
go install github.com/strahe/bwh/cmd/bwh@latest

# Go SDK
go get github.com/strahe/bwh
go get github.com/strahe/bwh/pkg/client@latest
```

## Quick Start
Expand Down Expand Up @@ -100,7 +101,7 @@ backups, err := c.ListBackups(ctx)

### Available Methods

The SDK sends read-only API calls with `GET` query parameters and state-changing API calls with `POST application/x-www-form-urlencoded` form data, so write parameters and credentials are not placed in the URL.
The SDK sends read-only API calls with `GET` query parameters and state-changing API calls with `POST application/x-www-form-urlencoded` form data. For write calls, request parameters and credentials are not placed in the URL.

**Server Management**: `GetServiceInfo`, `GetLiveServiceInfo`, `Start`, `Stop`, `Restart`, `Kill`, `SetHostname`, `ReinstallOS`, `ResetRootPassword`, `MountISO`, `UnmountISO`

Expand All @@ -116,7 +117,7 @@ The SDK sends read-only API calls with `GET` query parameters and state-changing

**Network**: SSH key management, IP/reverse DNS configuration, IPv6 subnet management, private IPv4 management

*Complete API reference*: View [pkg/client documentation](./pkg/client) or run `go doc github.com/strahe/bwh/pkg/client` for all available methods.
*Complete API reference*: View the [pkg.go.dev package documentation](https://pkg.go.dev/github.com/strahe/bwh/pkg/client) or run `go doc github.com/strahe/bwh/pkg/client` for all available methods.

## MCP Server Integration

Expand Down
7 changes: 4 additions & 3 deletions README.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![CI](https://github.com/strahe/bwh/actions/workflows/ci.yml/badge.svg)](https://github.com/strahe/bwh/actions/workflows/ci.yml)
[![Go Report Card](https://goreportcard.com/badge/github.com/strahe/bwh)](https://goreportcard.com/report/github.com/strahe/bwh)
[![Go Reference](https://pkg.go.dev/badge/github.com/strahe/bwh/pkg/client.svg)](https://pkg.go.dev/github.com/strahe/bwh/pkg/client)
[![Release](https://img.shields.io/github/v/release/strahe/bwh)](https://github.com/strahe/bwh/releases)

> **[English](README.md) | 中文**
Expand All @@ -19,7 +20,7 @@
go install github.com/strahe/bwh/cmd/bwh@latest

# Go SDK
go get github.com/strahe/bwh
go get github.com/strahe/bwh/pkg/client@latest
```

## 快速开始
Expand Down Expand Up @@ -100,7 +101,7 @@ backups, err := c.ListBackups(ctx)

### 可用方法

SDK 只读 API 调用使用 `GET` query 参数；会改变状态的写 API 调用使用 `POST application/x-www-form-urlencoded` 表单数据，因此写接口参数和凭据不会放在 URL 中。
SDK 只读 API 调用使用 `GET` query 参数；会改变状态的写 API 调用使用 `POST application/x-www-form-urlencoded` 表单数据。因此这类写调用的参数和凭据不会放在 URL 中。

**服务器管理**: `GetServiceInfo`、`GetLiveServiceInfo`、`Start`、`Stop`、`Restart`、`Kill`、`SetHostname`、`ReinstallOS`、`ResetRootPassword`、`MountISO`、`UnmountISO`

Expand All @@ -116,7 +117,7 @@ SDK 只读 API 调用使用 `GET` query 参数；会改变状态的写 API 调

**网络**: SSH 密钥管理、IP/反向 DNS 配置、IPv6 子网管理、私有 IPv4 管理

*完整 API 参考*: 查看 [pkg/client 文档](./pkg/client) 或运行 `go doc github.com/strahe/bwh/pkg/client` 获取所有可用方法。
*完整 API 参考*: 查看 [pkg.go.dev 包文档](https://pkg.go.dev/github.com/strahe/bwh/pkg/client) 或运行 `go doc github.com/strahe/bwh/pkg/client` 获取所有可用方法。

## MCP 服务器

Expand Down
Loading
Loading