about summary refs log tree commit
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2010-12-13 14:55:20 -0800
committerEric Wong <normalperson@yhbt.net>2010-12-13 14:55:20 -0800
commit636cca450a01da311a92dfbc85f08cd20bdae02d (patch)
treed45d1366b98a9cdb50addeddc5363c3fea01cc05
parent8735b2224f050372a5f1c41c5fc2ca1e0f52f485 (diff)
downloadmetropolis-636cca450a01da311a92dfbc85f08cd20bdae02d.tar.gz
minor documentation updates
This needs a LOT of work.
-rw-r--r--.document1
-rw-r--r--lib/metropolis.rb4
-rw-r--r--lib/metropolis/multi_hash.rb1
3 files changed, 6 insertions, 0 deletions
diff --git a/.document b/.document
index 1f6b28e..f02a4d1 100644
--- a/.document
+++ b/.document
@@ -4,3 +4,4 @@ ChangeLog
 COPYING
 LICENSE
 SPEC
+lib
diff --git a/lib/metropolis.rb b/lib/metropolis.rb
index 0af1465..51758b5 100644
--- a/lib/metropolis.rb
+++ b/lib/metropolis.rb
@@ -2,6 +2,10 @@
 require 'rack'
 require 'uri'
 
+# Metropolis is configured using Rack::Builder, so "run" it like
+# any other Rack application by placing it in your config.ru:
+#
+#     run Metropolis.new(:uri => "hash:///")
 module Metropolis
   autoload :InputWrapper, 'metropolis/input_wrapper'
   autoload :Deflate, 'metropolis/deflate'
diff --git a/lib/metropolis/multi_hash.rb b/lib/metropolis/multi_hash.rb
index 65ed6fe..7054883 100644
--- a/lib/metropolis/multi_hash.rb
+++ b/lib/metropolis/multi_hash.rb
@@ -1,4 +1,5 @@
 # -*- encoding: binary -*-
+# :enddoc:
 module Metropolis::MultiHash
   autoload :Digest, 'metropolis/multi_hash/digest'
   autoload :ToI, 'metropolis/multi_hash/to_i'