diff --git a/README.md b/README.md new file mode 100644 index 0000000..64d3acc --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# swaybar\_info + +## Usage + + # build the "release" build of the program + cargo build --release + # put the "release" build somewhere to be used by swaybar + cp ./target/release/swaybar_info ~/.config/sway/ + +Put the following in your `~/.config/sway/config`: + + bar { + position top + # Set --netdev= such that is the network device you + # want to monitor. You can omit --netdev=, but that will also + # cause the program to omit network traffic stats. + status_command $HOME/.config/sway/swaybar_info --netdev=enp7s0 + } + +## Dependencies + +Uses [`serde_json`](https://crates.io/crates/serde_json), +[`serde`](https://crates.io/crates/serde), +and [`chrono`](https://crates.io/crates/chrono).