aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2022-12-29 08:49:22 +0000
committerFuwn <[email protected]>2022-12-29 08:49:22 +0000
commit7928db68463f906b66c6398e4c7f15dace3904c9 (patch)
tree9b87409bd54b9a221f08cadd61fff7288b3eea62 /README.md
parentfeat: initial release (diff)
downloadelem-0.1.1.tar.xz
elem-0.1.1.zip
docs: add crates.io instructionsv0.1.1
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index c584381..087434c 100644
--- a/README.md
+++ b/README.md
@@ -6,10 +6,21 @@
Show your wireless Logitech devices battery levels in your system tray.
-The name comes from the hungarian word for battery: elem.
+The name comes from the Hungarian word for battery: elem.
## Usage
+### Installing from [crates.io](https://crates.io)
+
+To install from [crates.io](https://crates.io) you must have
+[Rust](https://www.rust-lang.org/) installed.
+
+```shell
+cargo install elem --force
+```
+
+### Downloading a Prebuilt Binary
+
To start using elem, download and execute the latest executable from the
releases page:
[Fuwn/elem/releases/latest](https://github.com/Fuwn/elem/releases/latest).