diff options
| author | diogo464 <[email protected]> | 2025-12-14 14:49:02 +0000 |
|---|---|---|
| committer | diogo464 <[email protected]> | 2025-12-14 14:49:02 +0000 |
| commit | 993d2a9fd34ce08760933a013e638108827f6f70 (patch) | |
| tree | 13897ca1a8eac0564fabc5b730bf9ae49a360fbb /README.tpl | |
| parent | ab4a7c83e00314a2f5d2f455987ba530fd08bdd7 (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 'README.tpl')
| -rw-r--r-- | README.tpl | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/README.tpl b/README.tpl new file mode 100644 index 0000000..dba64ff --- /dev/null +++ b/README.tpl | |||
| @@ -0,0 +1,15 @@ | |||
| 1 | # {{crate}} | ||
| 2 | |||
| 3 | [](https://crates.io/crates/embassy-ha) | ||
| 4 | [](https://docs.rs/embassy-ha) | ||
| 5 | |||
| 6 | {{readme}} | ||
| 7 | |||
| 8 | ## License | ||
| 9 | |||
| 10 | Licensed under either of: | ||
| 11 | |||
| 12 | - Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) | ||
| 13 | - MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) | ||
| 14 | |||
| 15 | at your option. | ||
