From cd6d638bfc9c86a768a3940077cd233889c4b865 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D7=A0=CF=85=CE=B1=CE=B7=20=D7=A0=CF=85=CE=B1=CE=B7=D1=95?= =?UTF-8?q?=CF=83=CE=B7?= Date: Mon, 2 Mar 2026 18:58:20 -0800 Subject: [PATCH] docs: add emoji icons to README section headings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2e30751..98fde5e 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,13 @@ Go SDK for [OSAPI][] — client library and orchestration primitives. -## Install +## 📦 Install ```bash go get github.com/osapi-io/osapi-sdk ``` -## SDK Client +## 🔌 SDK Client Typed Go client for every OSAPI endpoint. See the [client docs](docs/osapi/README.md) for targeting, options, and quick @@ -35,7 +35,7 @@ start. | Audit | List, get, export | [docs](docs/osapi/audit.md) | [`audit.go`](pkg/osapi/audit.go) | | Metrics | Prometheus text | [docs](docs/osapi/metrics.md) | [`metrics.go`](pkg/osapi/metrics.go) | -## Orchestration +## 🔀 Orchestration DAG-based task execution on top of the client. See the [orchestration docs](docs/orchestration/README.md) for hooks, error @@ -69,7 +69,7 @@ strategies, and adding new operations. | `command.exec.execute` | Execute a command | No | [docs](docs/orchestration/command-exec.md) | | `command.shell.execute` | Execute a shell string | No | [docs](docs/orchestration/command-shell.md) | -## Examples +## 📋 Examples Each example is a standalone Go program you can read and run. @@ -83,17 +83,17 @@ cd examples/discovery OSAPI_TOKEN="" go run main.go ``` -## Documentation +## 📖 Documentation See the [generated documentation][] for package-level API details. -## Contributing +## 🤝 Contributing See the [Development](docs/development.md) guide for prerequisites, setup, and conventions. See the [Contributing](docs/contributing.md) guide before submitting a PR. -## License +## 📄 License The [MIT][] License.