Add a quick 'n dirty README

1 files changed, 18 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..51f6e21
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+This is a really hacky plugin for spiffy that allows you to serve
+automatically-generated release-info files and files-list files
+(the latter of which serves as the files section of a meta-file)
+for an SVN repository.
+
+You can use it like this:
+
+(use spiffy spiffy-uri-match pseudo-meta-egg-info)
+
+;; Trailing slash is mandatory here!
+;; By default this uses the Chicken repo
+(egg-repo "http://example.com/your-egg-repo/eggs/release/4/")
+
+(vhost-map `((".*" 
+              . ,(uri-match/spiffy
+                  `(((/ "release-info") (GET ,release-info))
+                    ((/ "files-list")   (GET ,files-list)))))))
+(start-server)