From f162dc717550ddfe2098f4e7e511288bfd316d87 Mon Sep 17 00:00:00 2001
From: cool-mist <dev@neophyte.me>
Date: Wed, 8 Jul 2026 15:53:26 +0530
Subject: [PATCH] Update readme

---
 README.md | 24 +++++++++++++++++++++---
 1 file changed, 21 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 35ef4c4..9d2cec1 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,14 @@
-## Woly
+# Woly
 
-Construct Wake on Lan (WoL) magic packet to power on mini PC via LAN
+Broadcast Wake on Lan (WoL) magic packet to network devices in the local network.
+
+## Installation
+
+Install [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)
+
+```bash
+cargo install --git <thisRepoUrl>
+```
 
 ## Usage
 
@@ -8,6 +16,16 @@ Construct Wake on Lan (WoL) magic packet to power on mini PC via LAN
 woly aa:bb:cc:dd:ee:ff
 ```
 
+or define a nickname in `woly.conf` as
+
+```woly.conf
+idly=aa:bb:cc:dd:ee:ff
+```
+
+```
+woly idly
+```
+
 ## Magic Packet
 
 Magic packet is constructed as follows
@@ -35,7 +53,7 @@ AA BB CC DD EE FF
 AA BB CC DD EE FF
 ```
 
-## Target Destination
+### Target Destination
 
 The magic packet shall be sent to limited broadcast IP - `255.255.255.255` and the Discard Protocol Port `9`.