securemem-0.1.4: README.md

securemem
=========

[![Build Status](https://travis-ci.org/vincenthz/hs-securemem.png?branch=master)](https://travis-ci.org/vincenthz/hs-securemem)
[![BSD](http://b.repl.ca/v1/license-BSD-blue.png)](http://en.wikipedia.org/wiki/BSD_licenses)
[![Haskell](http://b.repl.ca/v1/language-haskell-lightgrey.png)](http://haskell.org)

Securemem provides memory chunks that allow auto-scrubbing of the memory after use,
and constant time equality.

Documentation: [securemem on hackage](http://hackage.haskell.org/package/securemem)

Interacting with securemem
--------------------------

It's recommended to use the [Byteable instance](http://hackage.haskell.org/package/byteable)
when providing an interface that takes a securemem. It allow legacy code, and work in progress
code to interface with securemem more easily.

older base
----------

On older base, the memory is not scrubbed: upgrade your GHC to 7.6.0 or above.

TODO
----

* add a custom memory allocator that give mlocked memory chunks.