Update Readme 🔧

Author: TRex22

README.md

@@ -1,8 +1,7 @@
 # Luno
+A client for the Luno API. See: https://www.luno.com/en/developers/api
 
-This is still a work in progress (WIP) ... more to come soon.
-
-This is a client for the Luno API. See: https://www.luno.com/en/developers/api
+This is an unofficial project and still a work in progress (WIP) ... more to come soon.
 
 ## Installation
 
@@ -22,14 +21,47 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+  require 'luno'
+  client  = Luno::Client.new(key: 'your key', secret: 'your secret')
+```
+
+### Endpoints
+  - Accounts
+  - Beneficiaries
+  - Markets
+  - Orders
+  - Quotes
+  - Receiving
+  - Sending
+  - Transactions
+  - Withdrawals
+
+### Beta Endpoints
+  - Lightning
+  - Streaming
+
+### Other Endpoints
+  - ping(limit: 4, paths: ['https://www.luno.com/', 'https://api.mybitx.com/api/1/'])
+  - countries
+  - currencies
+  - permissions
+  - changelog
+
+### Constants
+  Constants
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Tests
+To run tests execute:
+
+    $ rake test
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/trex22/luno. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

luno.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["[email protected]"]
 
   spec.summary       = "A client for using the Luno API in Ruby."
-  spec.description   = "A client for using the Luno API in Ruby. It relies on the swagger spec from their api documentation. https://www.luno.com/en/developers/api"
+  spec.description   = "A client for using the Luno API in Ruby. Built form their api documentation. https://www.luno.com/en/developers/api. This is an unofficial project."
   spec.homepage      = "https://github.com/TRex22/luno"
   spec.license       = "MIT"