README

   1
   2 libjio - A library for Journaled I/O
   3 Alberto Bertogli (albertogli@telpin.com.ar)
   4 -------------------------------------------
   5
   6 As the name says, this is a simple userspace library to do journaled,
   7 transaction-oriented I/O.
   8
   9 It provides a very simple transaction API to commit and rollback transactions,
  10 and on top of that a unix-alike set of functions to perform most regular
  11 operations (ie. open, read, write).
  12
  13 On the disk, the file you work on is exactly like a regular one, but a
  14 special directory is created to store in-flight transactions.
  15
  16 This allows both simple file manipulation, recovery and debugging because
  17 everything is isolated.
  18
  19 There are more detailed documents: a programming guide, a brief introduction
  20 to the design and inner workings, and the manpage; all in the doc/ directory.
  21
  22 The first two, called 'guide' and 'libjio' respectively, are both in txt and
  23 lyx formats, with HTML, Postscript and PDF versions in the website, which are
  24 not included in the package for space reasons.
  25
  26
  27 To see how to install it, please read the INSTALL file.
  28
  29 It is licensed under the Open Software License version 2.0.
  30
  31 Comments and patches are always welcome; please send them to my email address,
  32 albertogli@telpin.com.ar.
  33
  34 Thanks,
  35                 Alberto
  36