README.md in bitcoin-api-0.1.0 vs README.md in bitcoin-api-0.1.1
- old
+ new
@@ -1,5 +1,7 @@
+[](https://badge.fury.io/rb/bitcoin-api)
+
# Bitcoin
This is a CLI using the bitcoin.com exchange API to view market data and provide limited analysis.
CLI Demo video: https://youtu.be/z5k0Hnl88eA
@@ -9,30 +11,51 @@
- Support for trading
- Support for multiple exchanges
- Algotrading, arbitrage
- UI
-## Installation
+Walkthrough of source code: https://youtu.be/TuTf84mZAEY
-Add this line to your application's Gemfile:
+Blog Post: https://briannicholls.home.blog/2020/01/18/cli-project-bitcoin-com-crypto-api/
-```ruby
-gem 'bitcoin'
-```
+## Installation
+Add this line to your application's Gemfile:
+ ```ruby
+ gem 'bitcoin-api'
+ ```
And then execute:
-
+ ```
$ bundle install
+ ```
Or install it yourself as:
- $ gem "bitcoin_api", :git => "git://github.com/nichol88/bitcoin_api.git"
+ $ gem install bitcoin-api
+
## Usage
-Run `bin/console` to play around, or `bin/bitcoin` to start the CLI.
+In your code use:
+ ```ruby
+ require 'bitcoin'
+ Bitcoin::CLI.new # to start the CLI
+ ```
+
+If you've cloned the repo, run `bin/console` to play around, or `bin/bitcoin` to start the CLI.
+
+## Add API Key / Secret
+
+Get your API Key and secret from your account settings at https://exchange.bitcoin.com/settings/api-keys.
+
+Create a file named `.env` in root directory. The contents should look like this:
+
+```ruby
+API_KEY={your API key (no quotes or brackets)}
+SECRET={your Secret key (no quotes or brackets)}
+```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.