add README
authorDon Stewart <dons@cse.unsw.edu.au>
Thu, 11 Jan 2007 16:48:18 +0000 (17:48 +0100)
committerDon Stewart <dons@cse.unsw.edu.au>
Thu, 11 Jan 2007 16:48:18 +0000 (17:48 +0100)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..46be438
--- /dev/null
+++ b/README
@@ -0,0 +1,29 @@
+
+  binary: efficient, pure binary serialisation using lazy ByteStrings
+------------------------------------------------------------------------
+
+The 'binary' package provides Data.Binary, containing the Binary class,
+and associated methods, for serialising values to and from lazy
+ByteStrings. 
+
+A key feature of 'binary' is that the interface is both pure, and efficient.
+
+Building:
+
+    runhaskell Setup.hs configure
+    runhaskell Setup.hs build
+    runhaskell Setup.hs install
+
+Use:
+    import Data.Binary
+
+and then write an instance of Binary for the type you wish to serialise.
+More information in the haddock documentation.
+
+Contributors:
+
+    Lennart Kolmodin
+    Duncan Coutts
+    Don Stewart
+    Spencer Janssen
+