Add cursory documentation
authorChip Black <bytex64@bytex64.net>
Fri, 27 Jan 2012 09:51:39 +0000 (03:51 -0600)
committerChip Black <bytex64@bytex64.net>
Fri, 27 Jan 2012 09:51:39 +0000 (03:51 -0600)
README [new file with mode: 0644]
trac-attack.rc.example [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..e655153
--- /dev/null
+++ b/README
@@ -0,0 +1,16 @@
+trac-attack - a simple interface for trac using the XML-RPC interface
+
+trac-attack is currently a simple interface to trac's ticketing using
+the XML-RPC interface.  It's configured with a config file at
+~/.trac-attack.rc.  See trac-attack.rc.example for details.  There are
+also some command-line options:
+
+Usage: trac-attack.py [options]
+
+Options:
+  -h, --help            show this help message and exit
+  -t TRAC, --trac=TRAC  Which trac to connect to
+
+The -t option switches between sections in the config file.  If it is
+not specified, then the default option in the main section defines which
+trac section to use.
diff --git a/trac-attack.rc.example b/trac-attack.rc.example
new file mode 100644 (file)
index 0000000..ce30588
--- /dev/null
@@ -0,0 +1,9 @@
+[main]
+default = foo
+
+[queries]
+major = status!=closed&owner=$USER&priority=major
+
+[foo]
+user = henry
+url = https://henry:hunter2@trac.foo.com/login/rpc