summary history branches tags files
commit:2b8f51ea3a0c41624dbbf34add69a4f919e55c34
author:Trevor Bentley
committer:GitHub
date:Thu Nov 16 22:53:35 2017 +0100
parents:e6ad8b320a4630834e76225c30de048a0e949f58
Update README.md
diff --git a/README.md b/README.md
line changes: +17/-3
index 754f2ef..bda7bbc
--- a/README.md
+++ b/README.md
@@ -6,6 +6,8 @@
 
 Circadian is a background daemon/service for triggering suspend/sleep/hibernate automatically when a computer is idle.
 
+It is primarily for stationary devices with permanent power (i.e. desktops, servers, media centers).
+
 Circadian uses a suite of 'idle heuristics' to determine when a system is idle.  These include:
  * User activity in X11 (keyboard, mouse, full-screen playback)
  * User activity in terminals (typing in PTY/SSH session)
@@ -17,10 +19,20 @@ Circadian uses a suite of 'idle heuristics' to determine when a system is idle. 
 
 When all of its heuristics determine that your system has been idle for long enough, Circadian will execute a command.  This is typically a simple power suspend, but it can be configured to any desired action.
 
-It can execute another command when it detects that the system woke back up.
+Circadian can also schedule an automatic daily wakeup.  Simply set a wake time in its configuration file and it will wake up once every day at that time (if not already awake).  This allows an easy way to keep a machine updated and backed up, even if it is seldom used.
+
+It can also execute a command when it detects that the system has woken up from sleep, regardless of why it woke up.
 
 Circadian exists because modern Linux distros already support suspend-on-idle, but it is apparently a very buggy and unreliable domain.  After you've followed your distro's advice of poking a handful of conf files, tweaking a few XML hierarchies, writing a few scripts, wafting the smoke of burning sage across your keyboard, suspending gem stones from your machine, and whatever else may be recommended... perhaps try Circadian.
 
+## Example use cases
+
+* Gaming rig with noisy fans?  Auto-sleep when idle!
+* Storage/backup machine?  Auto-wake, backup, and auto-sleep!
+* Seldom used server, but needs to be available?  Wake-on-LAN, and auto-sleep when no SSH connections!
+* Wake up to your local music library?  Auto-wake, play music, and auto-sleep!
+* Media center that you only use in evenings? Sleep all day, auto-wake when you get home!
+
 ## Status
 
 "Works for me".  You try.  You give feedback on GitHub, or to <trevor@trevorbentley.com>.
@@ -29,10 +41,10 @@ Circadian exists because modern Linux distros already support suspend-on-idle, b
 
 ### Debian x86-64
 
-* Download [Circadian 0.3.0](https://github.com/mrmekon/circadian/releases/download/0.3.0/circadian_0.3.0-1_amd64.deb)
+* Download [Circadian 0.5.0](https://github.com/mrmekon/circadian/releases/download/0.5.0/circadian_0.5.0-1_amd64.deb)
 
 ```
-$ sudo dpkg -i circadian_0.3.0-1_amd64.deb
+$ sudo dpkg -i circadian_0.5.0-1_amd64.deb
 ```
 
 Edit /etc/circadian.conf to configure.  The default is to suspend with systemd after 2 hours of idle.
@@ -81,6 +93,8 @@ Follow systemd instructions, and port circadian.service to whatever format you w
     * cat
     * sh
 
+Auto-wake requires kernel support for the real-time clock (RTC).  You can check for the file `/sys/class/rtc/rtc0/wakealarm`.  You probably have it.
+
 ## Usage
 
 * Should run as root, ideally from systemd.