From 5ca37d3614d10b9deeb97768309cc70adcc555a9 Mon Sep 17 00:00:00 2001 From: Andrew Poelstra Date: Fri, 18 Jul 2014 07:53:03 -0700 Subject: [PATCH] Add README --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000..d9bed4c9 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ + +### Rust Bitcoin Library + +This library is badly incomplete --- though at this point it is perhaps stable +enough that pull requests could be accepted. + +Currently development is following the needs of the +[Wizard's Wallet](https://github.com/apoelstra/wizards-wallet), which is +a "lite" wallet which does SPV validation but maintains a full UTXO index. +Its purpose is to be a usable-though-risky wallet which supports experimental +user-facing features. + +Pull requests to generalize the library or introduce new use cases would +be great. + +### Building + +To build, start by obtaining [cargo](http://crates.io/). Then just run `cargo build`. +To run the test cases, do `cargo test`. Note that the tests must pass (and reasonably +complete unit tests provided for new features) before any submissions can be accepted. + + +