Rewrite README for crates.io; clarify docs.rs handling#25
Merged
Conversation
README: - Model after Python predecessor: logo, badges (crates.io), description, install (cargo + binary download), project structure, manifest example, .iql anchor reference, accurate mermaid diagram of the 3 execution flows (createorupdate / statecheck / exports-as-proxy), usage table, link to microsite for full docs - Mermaid diagram redrawn to match actual Rust implementation: createorupdate skips all checks; statecheck triggers traditional exists→check→deploy flow; exports-only path tries exports first as a single-query fast path, falls back to exists if empty Cargo.toml: - Add [package.metadata.docs.rs] no-default-features = true; this is a binary-only crate so there is no lib API to document — crates.io renders README.md via the readme field already set; lib.rs with include_str! is not applicable here https://claude.ai/code/session_01GzGtjMcwBXyVW3uKW4F2Ai
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
README:
Cargo.toml:
https://claude.ai/code/session_01GzGtjMcwBXyVW3uKW4F2Ai