aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorache <ache@ache.one>2026-08-04 10:05:42 +0200
committerache <ache@ache.one>2026-08-04 10:05:42 +0200
commitf5cd5329e89ec547aedf3d27975519e1c79af42b (patch)
treef85a58b79f0253d05d851d3dbdabdb64a19ef6b2 /README.md
parentAdd notes about next to be features (diff)
Add project description
Diffstat (limited to 'README.md')
-rw-r--r--README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..76798b1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# rusty-ping
+
+A replacement for [prettyping](https://github.com/denilsonsa/prettyping).
+
+A basic ping utility that tries to be visual, with no external dependencies.
+
+## Install
+
+```shell
+$ git clone https://github.com/ache/git/rusty-ping.git
+$ cd rusty-ping
+$ cargo install --path .
+```
+
+## Usage
+
+```shell
+$ cargo run -- <host>
+```
+
+or after installation:
+
+```shell
+$ rusty-ping <host>
+```
+
+## Technical Notes
+
+- `clap` to parse args
+- `tokio` for `mpsc`
+- `icmp` crates for the ping
+- Rust 2024 edition
+
+_Still WIP_