Skip to content

Commit

Permalink
* Remove .gem file from repo (it's redundant and could get out of syn…
Browse files Browse the repository at this point in the history
…c with the releases).

* Fix README and EXAMPLES from referencing shiphawk-ruby to just shiphawk.
* Fix copyright.
  • Loading branch information
aaronshiphawk committed Nov 3, 2015
1 parent 685b5fd commit d94adea
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 15 deletions.
20 changes: 10 additions & 10 deletions EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To make a connection to a ShipHawk server, create a Client connection:

```ruby
require 'rubygems'
require 'shiphawk-ruby'
require 'shiphawk'

# get an item based on item id
client = Shiphawk::Client.new(api_token: 'api_token')
Expand All @@ -32,7 +32,7 @@ Here's an example of retrieving an Item given the Item ID using the Shiphawk::Cl

```ruby
require 'rubygems'
require 'shiphawk-ruby'
require 'shiphawk'

# get an item based on item id
client = Shiphawk::Client.new(api_token: 'api_token')
Expand All @@ -45,7 +45,7 @@ Currently undocumented on Shiphawk's api guide, so please disregard for now.

```ruby
require 'rubygems'
require 'shiphawk-ruby'
require 'shiphawk'

# get an item based on item id
client = Shiphawk::Client.new(api_token: 'api_token')
Expand All @@ -57,7 +57,7 @@ Implemented but undocumented. Not sure how this is supposed to work.

```ruby
require 'rubygems'
require 'shiphawk-ruby'
require 'shiphawk'

# get an item based on item id
client = Shiphawk::Client.new(api_token: 'api_token')
Expand All @@ -70,7 +70,7 @@ Get a shipping quote. Documentation here: https://shiphawk.com/api-docs#!/rates/
Creating a quote
```ruby
require 'rubygems'
require 'shiphawk-ruby'
require 'shiphawk'

client = Shiphawk::Client.new(api_token: 'api_token')

Expand All @@ -90,7 +90,7 @@ Create customer note about a shipment

```ruby
require 'rubygems'
require 'shiphawk-ruby'
require 'shiphawk'

Shiphawk.notes_update(shipment_id, {body: "This is a classy note"})
```
Expand All @@ -101,7 +101,7 @@ Subscribe to tracking notifications for a shipment.

```ruby
require 'rubygems'
require 'shiphawk-ruby'
require 'shiphawk'

Shiphawk.shipments_status_update(shipment_id, {callback_url: "www.someawesomecallback.com/shipment-tracking-callback/#{shipment_id}"})
```
Expand All @@ -112,7 +112,7 @@ Create a shipment

```ruby
require 'rubygems'
require 'shiphawk-ruby'
require 'shiphawk'

data = {
xid: buyer_invoice.to_s,
Expand Down Expand Up @@ -140,7 +140,7 @@ Update a number of shipments at once (need to confirm)

```ruby
require 'rubygems'
require 'shiphawk-ruby'
require 'shiphawk'
Shiphawk.shipments_status_update({shipment_ids: [1,2,3], status: "in_transit"})
```

Expand All @@ -150,6 +150,6 @@ Get all zip codes using pagination.

```ruby
require 'rubygems'
require 'shiphawk-ruby'
require 'shiphawk'
Shiphawk.zip_codes_index
```
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) 2015 Robert Schmitt
Copyright (c) 2015 Hawk Applications Corp.

MIT License

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Ruby wrapper for the ShipHawk V3 API. The ShipHawk::Client gem provides an easy-
Add this line to your application's Gemfile:

```ruby
gem 'shiphawk-ruby'
gem 'shiphawk'
```

And then execute:
Expand All @@ -16,7 +16,7 @@ And then execute:

Or install it yourself as:

$ gem install shiphawk-ruby
$ gem install shiphawk

## Usage

Expand All @@ -39,4 +39,4 @@ When an *error status* is received from the server, the gem will raise an error

## Copyright

Copyright (c) 2015 HAWK Applications Inc., [Robert Schmitt]([email protected]). See LICENSE for details.
Copyright (c) 2015 Hawk Applications Corp. See LICENSE for details.
5 changes: 5 additions & 0 deletions history.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
=== 0.8.1 2015-11-03

* Remove .gem file from repo (it's redundant and could get out of sync with the releases).
* Fix README and EXAMPLES from referencing shiphawk-ruby to just shiphawk.
* Fix copyright.
2 changes: 1 addition & 1 deletion lib/shiphawk/version.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ module Shiphawk
module VERSION #:nodoc:
MAJOR = 0
MINOR = 8
PATCH = 0
PATCH = 1
PRE = nil
STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
end
Expand Down
Binary file removed shiphawk-0.8.0.gem
Binary file not shown.

0 comments on commit d94adea

Please sign in to comment.