From 21ccabe1dfd06b69b1f1fe9faeb82c9e6da8d6b2 Mon Sep 17 00:00:00 2001
From: murilo ijanc
Date: Sat, 22 Nov 2025 10:52:45 -0300
Subject: Improve README to add default sections when template is cli

---
 cli/template/README.md | 75 ++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 72 insertions(+), 3 deletions(-)

(limited to 'cli')

diff --git a/cli/template/README.md b/cli/template/README.md
index 3dcf61b..ea0d3ef 100644
--- a/cli/template/README.md
+++ b/cli/template/README.md
@@ -1,11 +1,80 @@
 # {{project-name}}
 
-## Run
+`{{project-name}}` {{project-description}}
+
+## Why
+
+## Features
+
+- Feature 1
+- Feature 2
+- Feature 3
+
+## Requirements
+
+- Rust toolchain (Rust 1.89 or newer recommended)
+
+To install Rust:
+
+```sh
+curl https://sh.rustup.rs -sSf | sh
+```
+
+Verify installation:
+
+```sh
+rustc --version
+cargo --version
+```
+
+## Building
+
+Clone the repository and build the binary:
+
+```sh
+git clone ssh://anon@ijanc.org/{{project-name}}
+cd {{project-name}}
+cargo build --release
+```
+
+The binary will be located at:
+
+```
+target/release/{{project-name}}
+```
+
+You can add it to your PATH, move it to `/usr/local/bin`.
+
+or
+
+```
+cargo install --path .
+```
+
+## Command Overview
+
+`{{project-name}}` currently supports one primary operation:
+
+### Command 1
+
+## Logging and verbosity
+
+`{{project-name}}` uses `tracing` for structured logging.
+
+By default, logs are shown at the INFO level.\
+Use `-v` to enable DEBUG logs:
+
+```
+{{project-name}} -v ...
+```
+
+Or configure via `RUST_LOG`:
 
 ```
-RUST_LOG=debug cargo run
+RUST_LOG=debug {{project-name}} ...
 ```
 
 ## License
 
-This project is licensed under the ISC license ([LICENSE](LICENSE) or http://opensource.org/licenses/ISC)
+This project is licensed under the ISC license ([LICENSE](LICENSE) or\
+http://opensource.org/licenses/ISC)
-- 
cgit v1.2.3