Prepare 0.1.0 release

CHANGELOG.md

@@ -5,11 +5,12 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [unreleased]
+## [0.1.0] - 2019-02-11
 ### Added
 - authentication via websocket
 - idiomatic websocket support for all resources
 - license and badge
+- examples and APIs endpoints in README
 ### Changed
 - extract REST API implementation into its own class
 

README.md

@@ -37,7 +37,7 @@ require 'bitmex-api'
 
 client = Bitmex::Client.new
 
-##### or add api_key, api_secret if you want to access private APIs
+# or add api_key, api_secret if you want to access private APIs
 client = Bitmex::Client.new api_key: 'KEY', api_secret: 'SECRET'
 ```
 

TODOs.org

@@ -19,7 +19,7 @@
 ** DONE orderbook, order resource
    CLOSED: [2019-01-29 Tue] SCHEDULED: <2019-01-29 Tue>
 ** refactoring: use class methods when working with multiple entities
-** issue: {"error":{"message":"Signature not valid.","name":"HTTPError"}} in user#executions
+** bug: {"error":{"message":"Signature not valid.","name":"HTTPError"}} in user#executions
 ** DONE liquidation, leaderboard, insurance, instrument, funding, execution, chat, announcement
    CLOSED: [2019-01-30 Wed] SCHEDULED: <2019-01-30 Wed>
 ** DONE refactoring: extract websocket common logic
@@ -29,3 +29,5 @@
 ** DONE add idiomatic websocket support for all resources
    CLOSED: [2019-02-10 Sun 16:57] SCHEDULED: <2019-02-10 Sun>
 ** refactoring: make user model to extend base class as well
+** DONE Release 1.0: API endpoints, examples in README
+   CLOSED: [2019-02-11 Mon] SCHEDULED: <2019-02-11 Mon>

bitmex.gemspec

@@ -1,4 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'bitmex/version'
 
@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Iulian Costan']
   spec.email         = ['iulian.costan@gmail.com']
 
-  spec.summary       = %q{Idiomatic Ruby library for BitMEX API}
-  spec.description   = %q{Fully-featured library for Rest/Websocket BitMEX API}
+  spec.summary       = 'Fully-featured, idiomatic Ruby library for BitMEX API'
+  spec.description   = 'Fully-featured, idiomatic Ruby library for BitMEX API'
   spec.homepage      = 'https://github.com/icostan/bitmex-api-ruby'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'