milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity

Add README

This commit is contained in:
Andrew Poelstra 2014-07-18 07:53:03 -07:00
parent dc943d9a7e
commit 5ca37d3614
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md Normal file
View File

@ -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.