about summary refs log tree commit homepage
path: root/README
diff options
context:
space:
mode:
authorEric Wong <normalperson@yhbt.net>2010-11-26 02:27:17 +0000
committerEric Wong <normalperson@yhbt.net>2010-12-01 09:45:32 +0000
commit58938c980f38a4581b4a0e8a780fffe7ac95bc93 (patch)
treeece822520cf8cbabe23f4559361afaf8346aa729 /README
downloadruby-tdb-58938c980f38a4581b4a0e8a780fffe7ac95bc93.tar.gz
Diffstat (limited to 'README')
-rw-r--r--README57
1 files changed, 57 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..6307f1b
--- /dev/null
+++ b/README
@@ -0,0 +1,57 @@
+= tdb - Trivial Database bindings for Ruby
+
+TDB is much like other DBM implementations, except it allows concurrent
+writer processes.  TDB was initially developed for Samba, but is used by
+other projects as well.  These Ruby bindings allow Ruby apps to read and
+write to the same databases used by Samba!
+
+== Features
+
+* Concurrent reader and writer processes may safely operate on the
+  same file.
+
+* Releases the GVL for slow disk operations under Ruby 1.9
+
+* Includes several {hash functions}[link:Hash_Functions]
+  not included by upstream TDB.
+
+== Install
+
+The original tdb library from the main [site]{http://tdb.samba.org/} is
+required.  Debian users can just <code>apt-get install tdb-dev</code>.
+
+The library consists of a C extension so you'll need a C compiler
+and Ruby development libraries/headers.
+
+You may download the tarball from our
+{site}[http://bogomips.org/ruby-tdb/] and run setup.rb after unpacking
+it:
+
+  http://bogomips.org/ruby-tdb/files/
+
+You may also install it via RubyGems on RubyGems.org:
+
+  gem install tdb
+
+You can get the latest source via git from the following locations
+(these versions may not be stable):
+
+  git://git.bogomips.org/ruby-tdb.git
+  git://repo.or.cz/ruby-tdb.git (mirror)
+
+You may browse the code from the web and download the latest snapshot
+tarballs here:
+
+* http://git.bogomips.org/cgit/ruby-tdb.git (cgit)
+* http://repo.or.cz/w/ruby-tdb.git (gitweb)
+
+See the HACKING guide on how to contribute and build prerelease gems
+from git.
+
+== Contact
+
+All feedback (bug reports, user/development dicussion, patches, pull
+requests) go to the {mailing list}[mailto:ruby.tdb@librelist.org].
+
+For the latest on tdb releases, you may check our NEWS page (and
+subscribe to our Atom feed).