nmdb: Add LevelDB support
[nmdb.git] / README
blob36e3411291c03bcde01459b3cc5dd4998b9417cf
2 nmdb - A multiprotocol network database manager
3 Alberto Bertogli (albertito@blitiri.com.ar)
4 ---------------------------------------------------
6 nmdb is a network database that can use different protocols to communicate
7 with its clients. At the moment, it supports TIPC, TCP, UDP and SCTP.
9 It consists of an in-memory cache, that saves (key, value) pairs, and a
10 persistent backend that stores the pairs on disk.
12 Both work combined, but the use of the persistent backend is optional, so you
13 can use the server only for cache queries, pretty much like memcached.
15 This source distribution is composed of several parts: the server called
16 "nmdb", the library and bindings for Python (2 and 3), D, NewLISP, Ruby,
17 Bigloo Scheme and Haskell. Each one has a separate directory, and is licensed
18 individually. See the LICENSE file for more information.
21 Documentation
22 -------------
24 Most documentation is in the nmdb and libnmdb manpages, and inside the doc/
25 directory. It is recommended that you read the User Guide (doc/guide.rst, or
26 the online version) to learn how to setup and use nmdb.
28 For additional documentation and resources, go to the project's website at
29 http://blitiri.com.ar/p/nmdb.
32 Where to report bugs
33 --------------------
35 If you want to report bugs, or have any questions or comments, just let me
36 know at albertito@blitiri.com.ar.