Skip to content

Commit 37d80db

Browse files
committed
Update README
1 parent 8217f74 commit 37d80db

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,33 @@ Webcoin is a Bitcoin client that works in Node.js and the browser. In the browse
1313

1414
You can use Webcoin to add Bitcoin payments to your application, without the need to hold your users' funds, and without making them trust any third-parties with their money. Webcoin is an [SPV](https://en.bitcoin.it/wiki/Thin_Client_Security#Simplified_Payment_Verification_.28SPV.29_Clients) light client, so it only uses a minimal amount of bandwidth and storage; it even works great on mobile devices!
1515

16+
## Status
17+
18+
Much of Webcoin is already written and works well, including:
19+
20+
- Downloading block headers from peers
21+
- Verifying block headers
22+
- Creating HD wallets
23+
- Filtering transactions with Bloom filters
24+
- Detecting incoming transactions confirmed in blocks
25+
26+
I am currently making some major refactors to the codebase, and documenting all of it. Much of the code in this repo is being broken out into smaller modules, each with comprehensive tests and docs. You can see the progress below:
27+
28+
### Roadmap
29+
30+
- [x] [`blockchain-spv`](https://github.com/mappum/blockchain-spv) - Stores blockchain headers and verifies with SPV
31+
- [x] [`bitcoin-util`](https://github.com/mappum/bitcoin-uti
32+
l) - Utility functions for Bitcoin hashes and targets
33+
- [ ] `bitcoin-wallet` - Sends and receives coins, and stores unspent outputs
34+
- [ ] `bitcoin-net` - Bitcoin networking that works in Node and the browser
35+
- [ ] `bitcoin-web-bridge` - A proxy that bridges the Bitcoin TCP and WebRTC networks
36+
- [ ] Parameters
37+
- [x] [`webcoin-bitcoin`](https://github.com/mappum/webcoin-bitcoin) - Bitcoin constants and network rules to use with Webcoin
38+
- [ ] `webcoin-testnet3` - Bitcoin Testnet 3 constants and network rules to use with Webcoin
39+
- [ ] `webcoin-litecoin` - Litecoin constants and network rules to use with Webcoin
40+
- [ ] `webcoin-zcash-testnet` - Zcash Testnet constants and network rules to use with Webcoin
41+
- [ ] `webcoin-elements-alpha` - Elements Alpha constants and network rules to use with Webcoin
42+
1643
## License (MIT)
1744

1845
Copyright 2015 Matt Bell

0 commit comments

Comments
 (0)