publish-prep: the v0.1 pre-publish round — the README, the CHANGELOG, the license files, the readme field

- README.md: the alktunnels-shape quick start (producer registration,
  the three consumer sessions, both doors, the producer-side
  listener), the architecture table, the feature matrix, the
  verification commands — self-contained, since docs/architecture/
  rides the package but docs/reviews|research|plans do not
- CHANGELOG.md: the Keep-a-Changelog 0.1.0 entry (the sibling shape:
  Unreleased section + tag links)
- LICENSE-MIT / LICENSE-APACHE: copied from the siblings (crates.io
  license-file convention; the crate license is dual from Cargo.toml)
- Cargo.toml: `readme = "README.md"` (the sibling pattern; the
  packaged crate showed `readme = false`)

Verification: cargo test + cargo test --all-features (15 suites each),
clippy --all-targets --all-features -D warnings, fmt --check, doc
--no-deps (0 warnings), wasm32-unknown-unknown check (default +
composed), publish --dry-run (64 files, 278.3 KiB).
This commit is contained in:
glm-5.3-flash committed 2026-09-27 18:47:45 +00:00
1 parent 13c6209b07
commit 4d9796be64
5 files changed
+557

No files matched your search

+1
View File
@@ -6,6 +6,7 @@ rust-version = "1.88"
license = "MIT OR Apache-2.0"
description = "SOCKS5 (RFC 1928) proxy protocol over alkcall channels: targeted-forked fast-socks5 typestate core plus producer/consumer sessions. Producer/consumer protocol crate."
repository = "https://git.alk.dev/alkdev/alksocks"
readme = "README.md"
keywords = ["socks5", "proxy", "rfc1928", "channels", "alkcall"]
categories = ["network-programming", "asynchronous"]
exclude = [".opencode/", "AGENTS.md", "docs/reviews/", "docs/research/", "docs/plans/", "tasks/", "docs/sdd_process.md"]