README.md in easypost-3.3.0 vs README.md in easypost-3.4.0
- old
+ new
@@ -2,43 +2,42 @@
[](https://github.com/EasyPost/easypost-ruby/actions?query=workflow%3ACI)
[](https://badge.fury.io/rb/easypost)
-EasyPost is a simple shipping API. You can sign up for an account at https://easypost.com
+EasyPost is a simple shipping API. You can sign up for an account at https://easypost.com.
-Installation
----------------
+## Installation
Install the gem:
-```
+```bash
gem install easypost
```
Import the EasyPost client in your application:
-```
+```ruby
require 'easypost'
```
-Example
-------------------
+## Example
```ruby
require 'easypost'
-EasyPost.api_key = 'cueqNZUb3ldeWTNX7MU3Mel8UXtaAMUi'
+EasyPost.api_key = 'API_KEY'
to_address = EasyPost::Address.create(
:name => 'Dr. Steve Brule',
:street1 => '179 N Harbor Dr',
:city => 'Redondo Beach',
:state => 'CA',
:zip => '90277',
:country => 'US',
:phone => '310-808-5243'
)
+
from_address = EasyPost::Address.create(
:company => 'EasyPost',
:street1 => '118 2nd Street',
:street2 => '4th Floor',
:city => 'San Francisco',
@@ -60,10 +59,11 @@
:value => 23.56,
:weight => 33,
:origin_country => 'us',
:hs_tariff_number => 123456
)
+
customs_info = EasyPost::CustomsInfo.create(
:integrated_form_type => 'form_2976',
:customs_certify => true,
:customs_signer => 'Dr. Pepper',
:contents_type => 'gift',
@@ -89,19 +89,25 @@
shipment.insure(amount: 100)
puts shipment.insurance
puts shipment.postage_label.label_url
-
```
-Documentation
---------------------
+## Documentation
Up-to-date documentation at: https://easypost.com/docs
-Tests
---------------------
+## Development
+```bash
+# Run tests
+bundle exec rspec
```
-rspec spec
-```
+
+## Releasing
+
+1. Update the version in `VERSION`
+1. Update the `CHANGELOG`
+1. Tag a release on GitHub
+1. Build the Gem `gem build easypost.gemspec`
+1. Publish the Gem `gem push easypost-X.X.X.gem` (replace `X.X.X` with the version being released)