Commits

Jason R. Coombs committed 5ac09b3

Updated readme

  • Participants
  • Parent commits ef5b72a
  • Tags 1100.2

Comments (0)

Files changed (1)

-.. -*- restructuredtext -*-
-
 ======
 pmxbot
 ======
 pmxbot listens to commands prefixed by a '!'
 If it's a command it knows it will reply, take an action, etc.
 It can search the web, quote you, track karma, make decisions,
-and do just about anything else you could want. It logs text in a sqlite3
-database, and eventually we'll write a web interface to it.
+and do just about anything else you could want. It stores logs and quotes
+and karma in a sqlite or MongoDB
+database, and there's a web interface for reviewing the logs and karma.
 
 Contains
 ========
 ============
 
 `pmxbot` requires Python 2.6 or 2.7. It also requires a few python
-packages:
-
-* python-irclib
-* pyyaml
-* feedparser
-* httplib2
-* pytz
-
-The web interface requires cherrypy and jinja2.
+packages as defined in setup.py.
 
 If using the MongoDB backend, it requires pymongo (otherwise, sqlite will
 be used).
 
-Optionally nosetests for the test suite.
-
 Testing
 =======
 
 Usage
 =====
 Once you've setup a config file, you just need to call ``pmxbot config.yaml``
-and it will join and connect. We recommend running pmxbot under djb's
-daemontools to make it automatically restart if it crashes.
+and it will join and connect. We recommend running pmxbot under
+daemontools, upstart, supervisord, or your favorite supervisor to make it
+automatically restart if it crashes (or terminates due to a planned
+restart).
 
 
 Custom Features
 pmxbot includes a web server for allowing users to view the logs, read the
 help, and check karma. You specify the host, port, base path, logo, title,
 etc with the same YAML config file. Just run like ``pmxbotweb config.yaml``
-and it will start up. I suggest using a tool like supervisor, daemontools,
-cherryd or somesuch to keep it running.
-
-
+and it will start up. Like pmxbot, use of a supervisor is recommended to
+restart the process following termination.