README.rdoc in xidle-0.0.1 vs README.rdoc in xidle-0.0.2
- old
+ new
@@ -1,7 +1,12 @@
= xidle
-Description goes here.
+xidle() is a function that returns the time of user inactivity during an X session (in milliseconds)
+
+Example:
+require 'xidle'
+sleep(2)
+p xidle
== Contributing to xidle
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it