Commits

Bryan O'Sullivan  committed 24a5e9b

Add README

  • Participants
  • Parent commits 58a7ca6

Comments (0)

Files changed (2)

+# Welcome to snappy
+
+snappy is a fast Haskell library for working with data compressed
+using Google's Snappy format.  It is implemented as a binding to the
+[Snappy library](http://code.google.com/p/snappy/).
+
+# Join in!
+
+We are happy to receive bug reports, fixes, documentation enhancements,
+and other improvements.
+
+Please report bugs via the
+[github issue tracker](http://github.com/mailrank/snappy/issues).
+
+Master [git repository](http://github.com/mailrank/snappy):
+
+* `git clone git://github.com/mailrank/snappy.git`
+
+There's also a [Mercurial mirror](http://bitbucket.org/bos/snappy):
+
+* `hg clone http://bitbucket.org/bos/snappy`
+
+(You can create and contribute changes using either git or Mercurial.)
+
+Authors
+-------
+
+This library is written and maintained by Bryan O'Sullivan,
+<bos@mailrank.com>.

File snappy.cabal

 build-type:     Simple
 cabal-version:  >= 1.6
 extra-source-files:
+  README.md
+  include/hs_snappy.h
   tests/Makefile
   tests/Properties.hs