publish prep: README + package hygiene (v0.1.0)

- README.md: honest, agnostic quick-start (server/client), identity
  model, feature table, invariants, scope boundary — written against
  the shipped API, sibling-crate style
- Cargo.toml: readme = README.md; exclude tests/ from the published
  package (matches the N-6 rationale — integration tests reference
  docs/reviews context and are not consumer docs)
- rust-version 1.88 / edition 2021 verified identical to the
  published siblings (alkcall 0.7.1, alktty 0.4.1, alktunnels 0.1.0)

Verification: cargo test (93 passed), cargo test --all-features
(123 passed), clippy -D warnings clean, fmt clean, doc warning-free,
cargo publish --dry-run --allow-dirty passes (16 files, 201.4KiB).
This commit is contained in:
2026-09-12 06:26:47 +00:00
parent f21b62c4b4
commit 37b5f025d0
2 changed files with 153 additions and 1 deletions
+2 -1
View File
@@ -6,9 +6,10 @@ rust-version = "1.88"
license = "MIT OR Apache-2.0"
description = "Shared TLS setup types: server and client rustls configs, cert resolvers, verifiers, and ACME state-machine wiring, transport-agnostic and shareable across transports."
repository = "https://git.alk.dev/alkdev/alktls"
readme = "README.md"
keywords = ["tls", "rustls", "acme", "noq", "network"]
categories = ["network-programming", "cryptography", "asynchronous"]
exclude = [".opencode/", "AGENTS.md", "tasks/", "docs/reviews/", "docs/research/", "docs/plans/", "docs/architecture/", "docs/sdd_process.md"]
exclude = [".opencode/", "AGENTS.md", "tasks/", "docs/reviews/", "docs/research/", "docs/plans/", "docs/architecture/", "docs/sdd_process.md", "tests/"]
[lib]
name = "alktls"