Browse files

minor doc tweaks

  • Loading branch information...
1 parent a80794a commit 82f16fd47c18ea32c4a37abf664cd6cf6cd7e498 Paul Hubbard committed Aug 18, 2009
Showing with 13 additions and 3 deletions.
  1. +13 −3 README → README.py
View
16 README → README.py
@@ -1,3 +1,10 @@
+#!/usr/bin/env python
+
+"""
+@file README.py
+@author Alex Clemesha
+@date 8/18/09
+
@mainpage
txrabbitmq - RabbitMQ's 'rabbitmqctl' as a Twisted Service.
@@ -31,19 +38,22 @@
Push data from RabbitMQ
-----------------------
-* From top-level dir run:
+-# From top-level dir run:
@code
$ twistd -n restrabbitmqctl
@endcode
-* Open 2 shells to dir `webui/push` and run:
+-# Open 2 shells to dir `webui/push` and run:
@code
$ python data_producer.py #first shell
$ orbited --config=rabbitmq.cfg #second shell
@endcode
-* Open ports 8000 and 9000, to see commands data and push, respectively
+-# Open ports 8000 and 9000, to see commands data and push, respectively
+"""
+
+print 'foo'

0 comments on commit 82f16fd

Please sign in to comment.