aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAmir Saeid <amir@glgdgt.com>2020-06-24 19:54:32 +0100
committerAmir Saeid <amir@glgdgt.com>2020-06-24 19:54:32 +0100
commit843b7b6ffab2b8b0d80f300c3533d28cac137e13 (patch)
treeb5586fcac1df69ca0b2cbb5b1f8ef9cfd89aacf0
parentff218ed8cbe7a048db785b14f9abd9f191cdd111 (diff)
Update README
-rw-r--r--README.md16
1 files changed, 14 insertions, 2 deletions
diff --git a/README.md b/README.md
index edf963c..adb9b14 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,26 @@
Based on [sct](https://flak.tedunangst.com/post/sct-set-color-temperature) by Ted Unangst. Calculates sunrise and sunset based on geo-pos lat/lon and sets the temperature accordingly. Can be left running, in which case transitions between tempratures. Transition logic is based on [redshift](https://github.com/jonls/redshift/).
+## Installation
+
+Precompiled binaries are [available](https://github.com/amir/sctd/releases).
+
+If you're an **Arch Linux** user, then you can install sctd from the official repos:
+
+```
+$ pacman -S sctd
+```
+
## Usage
### Set latitude and longitude
```bash
-$ cargo run -- --latitude 53.3498 --longitude -6.2603
+$ sctd --latitude 53.3498 --longitude -6.2603
```
### Reset
```bash
-$ cargo run -- --reset
+$ sctd --reset
```
+
+Executing `sctd` in `.xinitrc` is an easy way to start it with `startx`.