@dev-pi2pie/word-counter 0.1.3 → 0.1.4-canary.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -139,6 +139,29 @@ word-counter --path ./examples/test-case-multi-files-support --keep-progress
139
139
 
140
140
  Progress is transient by default, auto-disabled for single-input runs, and suppressed in `--format raw` and `--format json`.
141
141
 
142
+ ### Batch Concurrency (`--jobs`)
143
+
144
+ Use `--jobs` to control batch concurrency:
145
+
146
+ ```bash
147
+ word-counter --path ./examples/test-case-multi-files-support --jobs 1
148
+ word-counter --path ./examples/test-case-multi-files-support --jobs 4
149
+ ```
150
+
151
+ Quick policy:
152
+
153
+ - no `--jobs` and `--jobs 1` are equivalent baseline behavior.
154
+ - `--jobs > 1` enables concurrent `load+count`.
155
+ - if requested `--jobs` exceeds host `suggestedMaxJobs` (from `--print-jobs-limit`), the CLI warns and runs with the suggested limit as a safety cap.
156
+
157
+ Inspect host jobs diagnostics:
158
+
159
+ ```bash
160
+ word-counter --print-jobs-limit
161
+ ```
162
+
163
+ For full policy details, JSON parity expectations (`--misc`, `--total-of whitespace,words`), and benchmark standards, see [`docs/batch-jobs-usage-guide.md`](docs/batch-jobs-usage-guide.md).
164
+
142
165
  ### Stable Path Resolution Contract
143
166
 
144
167
  - Repeated `--path` values are accepted as mixed inputs (file + directory).