Skip to content

Commit a6fea92

Browse files
committed
Tweak wording in README
1 parent 52fb8ae commit a6fea92

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Just call `init_ctrlc()` once, then check `is_ctrlc_received()` in your loop.
1313

1414
- Signal-safe `SIGINT` handler
1515
- No threads, no allocations
16-
- Zero runtime dependencies
16+
- No runtime Rust dependencies
1717
- Ideal for polling-based CLI tools
1818

1919
## 🚀 Usage
@@ -46,12 +46,11 @@ Need to detect Ctrl-C more than once? See [`examples/multi_ctrlc.rs`](https://gi
4646

4747
## 🔍 Why not use `ctrlc`?
4848

49-
[`ctrlc`](https://crates.io/crates/ctrlc) provides a flexible way to handle signals using closures and shared state.
49+
[`ctrlc`](https://crates.io/crates/ctrlc) is great when you want to run custom logic when Ctrl-C is pressed.
5050

51-
It spawns a thread and communicates through channels, which is great for many use cases but may be more than you need if you're just polling for Ctrl-C.
51+
But if you just want to check whether Ctrl-C was pressed, it can feel more involved than necessary.
5252

53-
`ctrlc-tiny` is focused on one job: setting a flag when `SIGINT` is received.
54-
No threads, no handlers, no extra logic.
53+
`ctrlc-tiny` keeps things simple: a single flag you can poll.
5554

5655
## 🔒 Signal Safety
5756

@@ -63,7 +62,7 @@ No threads, no handlers, no extra logic.
6362

6463
- ✅ Linux
6564
- ✅ macOS
66-
- ❌ Windows
65+
- ❌ Windows (no plans to add support)
6766

6867
## 📦 License
6968

0 commit comments

Comments
 (0)