Add README.md

This commit is contained in:
Stephen Seo 2022-07-09 19:06:51 +09:00
parent c8ea5898af
commit 41b9fab6b1

24
README.md Normal file
View file

@ -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=<device> such that <device> is the network device you
# want to monitor. You can omit --netdev=<device>, 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).