README.rdoc in bitcoin-ruby-0.0.5 vs README.rdoc in bitcoin-ruby-0.0.6
- old
+ new
@@ -1,6 +1,6 @@
-= Bitcoin-ruby {<img src="https://api.travis-ci.org/lian/bitcoin-ruby.png?branch=master" />}[http://travis-ci.org/lian/bitcoin-ruby]
+= Bitcoin-ruby {<img src="https://api.travis-ci.org/lian/bitcoin-ruby.svg?branch=master" />}[http://travis-ci.org/lian/bitcoin-ruby]
This is a ruby library for interacting with the bitcoin protocol/network.
Some of the main features are:
@@ -13,26 +13,28 @@
* Bitcoin::Script implementation, create/run scripts and verify signatures
* Bitcoin::Key provides a high-level API for creating and handling keys/addresses
* Bitcoin::Builder provides a high-level API for creating transactions (and blocks)
* Bitcoin::Wallet is a draft implementation of a simple wallet
* Bitcoin::Namecoin implements all the namecoin-specific differences (see NAMECOIN)
+* Bitcoin::Litecoin implements all the litecoin-sepcific differences
== Compatible with...
* ruby 1.9.3
* ruby 2.0.0
+* ruby 2.1.2
== Installation
We assume you already have a ruby 1.9 or 2.0 compatible interpreter and rubygems environment.
git clone https://github.com/lian/bitcoin-ruby.git; cd bitcoin-ruby
ruby -Ilib bin/bitcoin_node
if you want to have it available system-wide, just build the gem and install it:
- gem build bitcoin-ruby.gemspec && gem install bitcoin-ruby-0.0.2.gem
+ gem build bitcoin-ruby.gemspec && gem install bitcoin-ruby-0.0.5.gem
now you can just call +bitcoin_node+ from anywhere.
Note that some aspects of the library (such as networking, storage, etc.) need
@@ -42,21 +44,22 @@
* +eventmachine+ to run a node / connect to peers
* +sequel+, +sqlite3+/+pg+/+mysql+ to use a storage backend
* +em-dns+ or +nslookup+ to get peer addrs from DNS seeds
* +gir_ffi+ for the gui
* +bacon+ to run the specs
+* +scrypt+ to use a much faster scrypt hash implementation for Litecoin
If you would like to install using Bundler, put it in your Gemfile and run bundle install
gem 'bitcoin-ruby', git: 'https://github.com/lian/bitcoin-ruby', branch: 'master', require: 'bitcoin'
== Client
There is a node which connects to the network and downloads
the blockchain into a database. see NODE, Bitcoin::Network::Node.
It also opens an extra socket where local clients can query statistics,
-monitor blockchain data, and relay there transactions to the network.
+monitor blockchain data, and relay their own transactions to the network.
see NODE, Bitcoin::Network::CommandHandler, Bitcoin::Network::CommandClient.
There is a WALLET implementation to manage a set of keys, list balances and create
transactions. see WALLET, Bitcoin::Wallet.
@@ -183,20 +186,20 @@
o.script {|s| s.recipient key.addr }
end
end
- # examine your transaction. you can relay it through http://webbtc.com/relay_tx
+ # examine your transaction. you can relay it through http://test.webbtc.com/relay_tx
# that will also give you a hint on the error if something goes wrong
puts new_tx.to_json
=== Node / Network connections
The Bitcoin::Network::Node can connect to peers and download the blockchain into a
Bitcoin::Storage backend. For now it works completely self-contained:
- node = Bitcoin::Network::Node.new(options) # options = {:network => :bitcoin, ...}
+ node = Bitcoin::Network::Node.new(options) # options = {network: :bitcoin, ...}
node.run
In the future you will be able to register callbacks to the node and control many aspects
of its operation yourself. Also see NODE.
@@ -252,5 +255,8 @@
to cleaning up high-level naming conventions, there is something for everyone to do.
Even if you are completely lost, just pointing out what is unclear helps a lot!
If you are curious or like to participate in development, drop by \#bitcoin-ruby on irc.freenode.net!
+== License
+
+Available here: [link:COPYING]