README

   1 = \Metropolis: a key-value store for Rack
   2
   3 \Metropolis is a Rack application used to store key value pairs.  It
   4 seeks to emulate the TokyoTyrant HTTP interface, but allows access to
   5 multiple databases through a single TCP port.  It hashes keys to split
   6 keys between different on-disk databases to work around scalability
   7 limitations of the kernel, hardware and filesystem.
   8
   9 == Features
  10
  11 * Currently supports the {TDB}[http://bogomips.org/ruby-tdb/] database
  12   along with the TokyoCabinet hash database format, other database
  13   formats will be supported along with KyotoCabinet, as well as other
  14   key-value stores.
  15
  16 * Compatible with all Rack-compatible servers
  17
  18 == Hacking
  19
  20 You can get the latest source via git from the following locations:
  21
  22   git://git.bogomips.org/metropolis.git
  23   git://repo.or.cz/metropolis.git (mirror)
  24
  25 You may browse the code from the web and download the latest snapshot
  26 tarballs here:
  27
  28 * http://git.bogomips.org/cgit/metropolis.git (cgit)
  29 * http://repo.or.cz/w/metropolis.git (gitweb)
  30
  31 Inline patches (from "git format-patch") to the mailing list are
  32 preferred because they allow code review and comments in the reply to
  33 the patch.
  34
  35 We will adhere to mostly the same conventions for patch submissions as
  36 git itself.  See the Documentation/SubmittingPatches document
  37 distributed with git on on patch submission guidelines to follow.  Just
  38 don't email the git mailing list or maintainer with \Metropolis patches.
  39
  40 == Contact
  41
  42 All feedback (bug reports, user/development discussion, patches, pull
  43 requests) go to the mailing list: mailto:metropolis@librelist.org
  44
  45 Mailing list archives in mbox format may be downloaded here:
  46
  47 http://metropolis.bogomips.org/archives/