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 TokyoCabinet hash database format, other
  12   database formats will be supported along with KyotoCabinet, as
  13   well as other key-value stores.
  14
  15 * Compatible with all Rack-compatible servers
  16
  17 == Hacking
  18
  19 You can get the latest source via git from the following locations:
  20
  21   git://git.bogomips.org/metropolis.git
  22   git://repo.or.cz/metropolis.git (mirror)
  23
  24 You may browse the code from the web and download the latest snapshot
  25 tarballs here:
  26
  27 * http://git.bogomips.org/cgit/metropolis.git (cgit)
  28 * http://repo.or.cz/w/metropolis.git (gitweb)
  29
  30 Inline patches (from "git format-patch") to the mailing list are
  31 preferred because they allow code review and comments in the reply to
  32 the patch.
  33
  34 We will adhere to mostly the same conventions for patch submissions as
  35 git itself.  See the Documentation/SubmittingPatches document
  36 distributed with git on on patch submission guidelines to follow.  Just
  37 don't email the git mailing list or maintainer with \Metropolis patches.
  38
  39 == Contact
  40
  41 All feedback (bug reports, user/development discussion, patches, pull
  42 requests) go to the mailing list: mailto:metropolis@librelist.org
  43
  44 Mailing list archives in mbox format may be downloaded here:
  45
  46 http://metropolis.bogomips.org/archives/