Customize the README with clearer instructions

Author: androse

README.md

@@ -1,78 +1,77 @@
-# patch_ruby
+# Patch ruby
+![Test](https://github.com/patch-technology/patch-ruby/workflows/Test/badge.svg)
 
-PatchRuby - the Ruby gem for the Patch API V1
+The official Ruby gem for the [Patch API](https://www.usepatch.com)
 
-The core API used to integrate with Patch's service
+## Documentation
 
-This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
-
-- API version: v1
-- Package version: 1.0.0
-- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+For detailed documentation and examples, see the [Patch API docs](https://www.usepatch.com).
 
 ## Installation
 
-### Build a gem
-
-To build the Ruby code into a gem:
-
-```shell
-gem build patch_ruby.gemspec
+Add the gem to your Gemfile:
+```ruby
+gem 'patch_ruby'
 ```
 
-Then either install the gem locally:
-
+Then run:
 ```shell
-gem install ./patch_ruby-1.0.0.gem
+bundle
 ```
 
-(for development, run `gem install --dev ./patch_ruby-1.0.0.gem` to install the development dependencies)
-
-or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
-
-Finally add this to the Gemfile:
-
-    gem 'patch_ruby', '~> 1.0.0'
-
-### Install from Git
-
-If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
-
-    gem 'patch_ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
-
-### Include the Ruby code directly
-
-Include the Ruby code directly using `-I` as follows:
-
+Or install it directly with
 ```shell
-ruby -Ilib script.rb
+gem install patch_ruby
 ```
 
-## Getting Started
+### Requirements
+- Ruby 1.9+
 
-Please follow the [installation](#installation) procedure and then run the following code:
+## Usage
 
+After installing the gem, you'll have to configure it with your API key which is available from the API key page in the Patch dashboard:
 ```ruby
-# Load the gem
 require 'patch_ruby'
 
-# Setup authorization
 PatchRuby.configure do |config|
-  # Configure Bearer authorization: bearer_auth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+  # Configure the Patch gem with your API key here
+  config.access_token = 'key_test_1234'
 end
+```
 
-api_instance = PatchRuby::OrdersApi.new
-id = 'id_example' # String | 
+Once configured, you can test it out:
+```ruby
+# Retrieve and print all your orders
+orders_api = PatchRuby::OrdersApi.new
 
 begin
-  #Cancel an order
-  result = api_instance.cancel_order(id)
-  p result
+  orders_response = orders_api.retrieve_orders
+
+  orders_response.data.each do |order|
+    puts "Order ID: #{order.id}, Order State: #{order.state}"
+  end
+# Rescue from any Patch API errors
 rescue PatchRuby::ApiError => e
-  puts "Exception when calling OrdersApi->cancel_order: #{e}"
+  puts "Failed to retrieve Orders with status code #{e.code}: #{e.message}"
 end
+```
 
+## Development
+
+Install dependencies:
+```shell
+bundle install --path vendor/bundle
+```
+
+Run tests:
+```shell
+bundle exec rspec
+```
+
+Building and installing the gem locally:
+```shell
+gem build patch_ruby.gemspec
+gem install patch_ruby-<version>.gem
 ```
 
 ## Documentation for API Endpoints
@@ -108,11 +107,3 @@ Class | Method | HTTP request | Description
  - [PatchRuby::ProjectListResponse](docs/ProjectListResponse.md)
  - [PatchRuby::ProjectResponse](docs/ProjectResponse.md)
 
-
-## Documentation for Authorization
-
-
-### bearer_auth
-
-- **Type**: Bearer authentication
-