aboutsummaryrefslogtreecommitdiff
path: root/generate-readme.sh
diff options
context:
space:
mode:
authordiogo464 <[email protected]>2025-12-14 14:49:02 +0000
committerdiogo464 <[email protected]>2025-12-14 14:49:02 +0000
commit993d2a9fd34ce08760933a013e638108827f6f70 (patch)
tree13897ca1a8eac0564fabc5b730bf9ae49a360fbb /generate-readme.sh
parentab4a7c83e00314a2f5d2f455987ba530fd08bdd7 (diff)
Improve documentation and replace publish_on_command with CommandPolicy enum
- Enhanced crate-level documentation with comprehensive examples and feature list - Improved README with badges, better structure, and clearer examples - Added README.tpl template and generate-readme.sh script for cargo-readme - Documented run() and connect_and_run() functions with detailed behavior explanations - Replaced publish_on_command boolean with CommandPolicy enum (PublishState/Manual) - Added comprehensive documentation for CommandPolicy explaining both modes 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
Diffstat (limited to 'generate-readme.sh')
-rwxr-xr-xgenerate-readme.sh5
1 files changed, 5 insertions, 0 deletions
diff --git a/generate-readme.sh b/generate-readme.sh
new file mode 100755
index 0000000..18c2123
--- /dev/null
+++ b/generate-readme.sh
@@ -0,0 +1,5 @@
1#!/bin/bash
2set -e
3
4cargo readme -o README.md
5echo "README.md generated successfully"