Merge branch 'master' of github.com:kalekundert/stack_alert

README.rst

@@ -25,8 +25,10 @@ using regular expressions against the title and body of the question.
 
 Getting Started
 ===============
-Install stack_alert using ``pip``::
+Install ``stack_alert`` using ``pip``, preferably into a clean virtual environment::
 
+    $ python -m venv ~/stack_alert_venv
+    $ ~/stack_alert_venv/bin/activate
     $ pip install stack_alert
 
 Specify which questions you want to receive alerts for::
@@ -38,12 +40,10 @@ Specify which questions you want to receive alerts for::
   keywords = '(num|sci)py'  # regular expression
   recipient = 'alice@example.com'
   
-Configure `cron` to call `stack_alert` at 5:00 PM every day::
-
-  $ crontab -e
-  0 17 * * * stack_alert
-  
-Log messages are written to stderr.  I recommend using `ts <http://joeyh.name/code/moreutils/>`__ and `tinylog <http://b0llix.net/perp/site.cgi?page=tinylog.8>`__ to collect and rotate these messages::
+Configure `cron` to call ``stack_alert`` at 5:00 PM every day.  Log messages are written to stderr.  I recommend using `ts <http://joeyh.name/code/moreutils/>`__ and `tinylog <http://b0llix.net/perp/site.cgi?page=tinylog.8>`__ to collect and rotate these messages.  Make sure that ``$PATH`` includes the ``stack_alert`` virtual environment, the aforementioned logging programs, and ``sendmail``::
 
+  $ which sendmail
+  /usr/sbin/sendmail
   $ crontab -e
+  PATH=$HOME/stack_alert_venv/bin:/usr/sbin:/usr/bin:/bin
   0 17 * * * stack_alert 2>&1 | ts | tinylog /path/to/log/dir

stack_alert/__init__.py

@@ -4,7 +4,7 @@
 Be notified when interesting questions are posted to Stack Exchange sites.
 """
 
-__version__ = '0.0.0'
+__version__ = '0.1.0'
 
 from .api import *