diff --git a/Cargo.lock b/Cargo.lock index 699b465..825ad3e 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -54,7 +54,7 @@ dependencies = [ [[package]] name = "lookaround" -version = "0.1.4" +version = "0.1.5" dependencies = [ "mac_address", "rand", diff --git a/Cargo.toml b/Cargo.toml index a997e45..8d0b66d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -9,7 +9,7 @@ license = "AGPL-3.0" name = "lookaround" readme = "README.md" repository = "https://six-five-six-four.com/git/reactor/lookaround" -version = "0.1.4" +version = "0.1.5" [dependencies] mac_address = "1.1.2" diff --git a/README.md b/README.md index c58beb0..79e59f2 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,6 @@ _Has this ever happened to you?_ -LookAround is a Rust program for looking up your computers' MAC and IP addresses -within a LAN. There's no central server, so it's not a look-up, it's a look-around. - ```text $ lookaround client @@ -15,12 +12,14 @@ Found 3 peers: 33:33:33:33:33:33 = 192.168.1.103 `old-laptop` ``` -The LookAround client uses IP multicast to find LookAround servers within the -same multicast domain. +LookAround is a Rust program for looking up your computers' MAC and IP addresses +within a LAN. There's no central server, so it's not a look-up, it's a look-around. -MAC addresses change slower than IP addresses, so if you know that -`11:11:11:11:11:11` is your laptop, and your laptop is running LookAround, -LookAround will find the IP for you. +The client uses IP multicast to find servers within the +same multicast domain, similar to Avahi and Bonjour. + +Systems self-identify by MAC address and nicknames. Public keys with +TOFU semantics are intended before v1.0.0. ## Installation @@ -57,7 +56,7 @@ systemctl --user enable lookaround Run the server manually: (If you haven't installed it with systemd yet) ```bash -lookaround server +lookaround server --nickname my-desktop ``` Run a client to ping all servers in the same multi-cast domain: @@ -66,6 +65,12 @@ Run a client to ping all servers in the same multi-cast domain: lookaround client ``` +Check which IP addresses LookAround will auto-detect: + +```bash +lookaround my-ips +``` + ## Contributing Pull requests are welcome. This is a hobby project, so I may reject contributions that are too big to review.