DEV-1012: Update README to conform to new style guide (#64)

* DEV-1012: Update README to conform to new style guide

* Minor edits

* Remove `public-suffix` variable and reference link directly

* Update README.md

* Apply suggestions from code review

Co-authored-by: James Coon <james@jcoon.dev>

Author: ShreyaThapa

.gitignore

@@ -8,3 +8,9 @@
 /spec/reports/
 /tmp/
 /vendor/
+
+# Visual Studio Code
+.vscode/
+
+# IntelliJ Idea
+.idea/

README.md

@@ -1,12 +1,30 @@
-# DwollaV2
+# Dwolla SDK for Ruby
 
 ![Build Status](https://travis-ci.org/Dwolla/dwolla-v2-ruby.svg)
 
-Dwolla V2 Ruby client.
+This repository contains the source code for Dwolla's Ruby-based SDK, which allows developers to interact with Dwolla's server-side API via a Ruby API, with automatic OAuth token management included. Any action that can be performed via an HTTP request can be made using this SDK when executed within a server-side environment.
 
-[API Documentation](https://docsv2.dwolla.com)
+## Table of Contents
 
-## Installation
+- [Getting Started](#getting-started)
+  - [Installation](#installation)
+  - [Initialization](#initialization)
+- [Making Requests](#making-requests)
+  - [Low-level Requests](#low-level-requests)
+    - [Setting Headers](#setting-headers)
+    - [Responses](#responses)
+      - [Success](#success)
+      - [Error](#error)
+- [Changelog](#changelog)
+- [Community](#community)
+- [Additional Resources](#additional-resources)
+
+
+## Getting Started
+
+### Installation
+
+To begin using this SDK, you will first need to download it to your machine. We use [RubyGems](https://rubygems.org/gems/dwolla_v2) to distribute this package.
 
 Add this line to your application's Gemfile:
 
@@ -22,15 +40,14 @@ Or install it yourself as:
 
     $ gem install dwolla_v2
 
-## `DwollaV2::Client`
+### Initialization
 
-### Basic usage
+Before any API requests can be made, you must first determine which environment you will be using, as well as fetch the application key and secret. To fetch your application key and secret, please visit one of the following links:
 
-Create a client using your application's consumer key and secret found on the applications page
-([Sandbox][apsandbox], [Production][approd]).
+* Production: https://dashboard.dwolla.com/applications
+* Sandbox: https://dashboard-sandbox.dwolla.com/applications
 
-[apsandbox]: https://dashboard-sandbox.dwolla.com/applications
-[approd]: https://dashboard.dwolla.com/applications
+Finally, you can create an instance of `Client` with `key` and `secret` replaced with the application key and secret that you fetched from one of the aforementioned links, respectively.
 
 ```ruby
 # config/initializers/dwolla.rb
@@ -41,13 +58,9 @@ $dwolla = DwollaV2::Client.new(
 )
 ```
 
-### Integrations Authorization
+#### Configure Faraday (Optional)
 
-Check out our [Integrations Authorization Guide](https://developers.dwolla.com/integrations/authorization).
-
-### Configure Faraday (optional)
-
-DwollaV2 uses [Faraday][faraday] to make HTTP requests. You can configure your own
+Dwolla for Ruby uses [Faraday][faraday] to make HTTP requests. You can configure your own
 [Faraday middleware][faraday-middleware] and adapter when configuring your client. Remember to
 always include an adapter last, even if you want to use the default adapter.
 
@@ -68,27 +81,38 @@ $dwolla = DwollaV2::Client.new(
 end
 ```
 
-## Requests
+## Making Requests
+
+Once you've created a `Client`, currently, you can make low-level HTTP requests.
 
-`DwollaV2::Client`s can make requests using the `#get`, `#post`, and `#delete` methods.
+### Low-level Requests
 
+To make low-level HTTP requests, you can use the [`get()`](#get), [`post()`](#post), and [`delete()`](#delete) methods.
+
+#### `GET`
 ```ruby
 # GET api.dwolla.com/resource?foo=bar
 $dwolla.get "resource", foo: "bar"
+```
 
+#### `POST`
+```ruby
 # POST api.dwolla.com/resource {"foo":"bar"}
 $dwolla.post "resource", foo: "bar"
 
 # POST api.dwolla.com/resource multipart/form-data foo=...
 $dwolla.post "resource", foo: Faraday::UploadIO.new("/path/to/bar.png", "image/png")
+```
 
+#### `DELETE`
+```ruby
 # DELETE api.dwolla.com/resource
 $dwolla.delete "resource"
 ```
 
-#### Setting headers
+##### Setting Headers
 
-To set additional headers on a request you can pass a `Hash` of headers as the 3rd argument.
+To set additional headers on a request, you can pass a `Hash` of headers as the 3rd argument.
 
 For example:
 
@@ -97,9 +121,15 @@ $dwolla.post "customers", { firstName: "John", lastName: "Doe", email: "jd@doe.c
                           { 'Idempotency-Key': 'a52fcf63-0730-41c3-96e8-7147b5d1fb01' }
 ```
 
-## Responses
+#### Responses
+
+The following snippets demonstrate successful and errored responses from the Dwolla API.
+
+An errored response is returned when Dwolla's servers respond with a status code that is greater than or equal to 400, whereas a successful response is when Dwolla's servers respond with a 200-level status code.
 
-Requests return a `DwollaV2::Response`.
+##### Success
+
+Successful requests return a `DwollaV2::Response`.
 
 ```ruby
 res = $dwolla.get "/"
@@ -115,7 +145,7 @@ res._links.events.href
 # => "https://api-sandbox.dwolla.com/events"
 ```
 
-## Errors
+##### Error
 
 If the server returns an error, a `DwollaV2::Error` (or one of its subclasses) will be raised.
 `DwollaV2::Error`s are similar to `DwollaV2::Response`s.
@@ -140,9 +170,10 @@ rescue DwollaV2::Error => e
 end
 ```
 
-### `DwollaV2::Error` subclasses:
 
-_See https://docsv2.dwolla.com/#errors for more info._
+###### `DwollaV2::Error` subclasses:
+
+_See https://developers.dwolla.com/api-reference#errors for more info._
 
 - `DwollaV2::AccessDeniedError`
 - `DwollaV2::InvalidCredentialsError`
@@ -171,37 +202,23 @@ _See https://docsv2.dwolla.com/#errors for more info._
 - `DwollaV2::TooManyRequestsError`
 - `DwollaV2::ConflictError`
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/Dwolla/dwolla-v2-ruby.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://github.com/Dwolla/dwolla-v2-ruby).
-
 ## Changelog
 
-- **3.1.1** - Fix deprecation warning on Faraday::Connection#authorization (Thanks @javierjulio!). [#60](https://github.com/Dwolla/dwolla-v2-ruby/pull/60)
-- **3.1.0** - Added `DwollaV2::MaxNumberOfResourcesError` (Thanks @paulyeo21!). [#54](https://github.com/Dwolla/dwolla-v2-ruby/pull/54)
-- **3.0.1** - Update dependencies (Thanks @sealabcore!). [#48](https://github.com/Dwolla/dwolla-v2-ruby/pull/48)
+- **3.1.1** - Fix deprecation warning on Faraday::Connection#authorization (Thanks [@javierjulio](https://github.com/javierjulio)!). [#60](https://github.com/Dwolla/dwolla-v2-ruby/pull/60)
+- **3.1.0** - Added `DwollaV2::MaxNumberOfResourcesError` (Thanks [@paulyeo21](https://github.com/paulyeo21)!). [#54](https://github.com/Dwolla/dwolla-v2-ruby/pull/54)
+- **3.0.1** - Update dependencies (Thanks [@sealabcore](https://github.com/sealabcore)!). [#48](https://github.com/Dwolla/dwolla-v2-ruby/pull/48)
 - **3.0.0** - Add integrations auth functions
 - **3.0.0.beta1** - Add token management functionality to `DwollaV2::Client`
 - **2.2.1** - Update dependencies
 - **2.2.0** - Change token url from `www.dwolla.com/oauth/v2/token` to `accounts.dwolla.com/token`
-- **2.1.0** - Ensure `Time.iso8601` is defined so timestamps get parsed. [#38](https://github.com/Dwolla/dwolla-v2-ruby/pull/38) (Thanks @javierjulio!)
-- **2.0.3** - Add `DuplicateResourceError` [#34](https://github.com/Dwolla/dwolla-v2-ruby/pull/34) (Thanks @javierjulio!)
-- **2.0.2** - Fix bug in [#30](https://github.com/Dwolla/dwolla-v2-ruby/pull/30) (Thanks again @sobrinho!)
-- **2.0.1** - Fix bugs in [#27](https://github.com/Dwolla/dwolla-v2-ruby/pull/27) + [#28](https://github.com/Dwolla/dwolla-v2-ruby/pull/28) (Thanks @sobrinho!)
+- **2.1.0** - Ensure `Time.iso8601` is defined so timestamps get parsed. [#38](https://github.com/Dwolla/dwolla-v2-ruby/pull/38) (Thanks [@javierjulio](https://github.com/javierjulio)!)
+- **2.0.3** - Add `DuplicateResourceError` [#34](https://github.com/Dwolla/dwolla-v2-ruby/pull/34) (Thanks [@javierjulio](https://github.com/javierjulio)!)
+- **2.0.2** - Fix bug in [#30](https://github.com/Dwolla/dwolla-v2-ruby/pull/30) (Thanks again [@sobrinho](https://github.com/sobrinho)!
+- **2.0.1** - Fix bugs in [#27](https://github.com/Dwolla/dwolla-v2-ruby/pull/27) + [#28](https://github.com/Dwolla/dwolla-v2-ruby/pull/28) (Thanks [@sobrinho](https://github.com/sobrinho)!)
 - **2.0.0**
 - Rename `DwollaV2::Response` `#status` => `#response_status`, `#headers` => `#response_headers` to prevent
-  [conflicts with response body properties][response-conflicts].
-- Remove support for Ruby versions < 2 ([Bump public_suffix dependency version][public-suffix]).
+  [conflicts with response body properties](https://discuss.dwolla.com/t/document-change-or-more-clarifiation/3964).
+- Remove support for Ruby versions < 2 ([Bump public_suffix dependency version](https://github.com/Dwolla/dwolla-v2-ruby/pull/18#discussion_r108028135)).
 - **1.2.3** - Implement `#empty?` on `DwollaV2::Token` to allow it to be passed to ActiveRecord constructor.
 - **1.2.2** - Strip domain from URLs provided to `token.*` methods.
 - **1.2.1** - Update sandbox URLs from uat => sandbox.
@@ -217,5 +234,24 @@ The gem is available as open source under the terms of the [MIT License](https:/
 - **0.2.0** - Works with `attr_encrypted`
 - **0.1.1** - Handle 500 error with HTML response body when requesting a token
 
-[response-conflicts]: https://discuss.dwolla.com/t/document-change-or-more-clarifiation/3964
-[public-suffix]: https://github.com/Dwolla/dwolla-v2-ruby/pull/18#discussion_r108028135
+## Community
+* If you have any feedback, please reach out to us on [our forums](https://discuss.dwolla.com/) or by [creating a GitHub issue](https://github.com/Dwolla/dwolla-v2-ruby/issues/new).
+* If you would like to contribute to this library, [bug reports](https://github.com/Dwolla/dwolla-v2-ruby/issues) and [pull requests](https://github.com/Dwolla/dwolla-v2-ruby/pulls) are always appreciated!
+  * After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+  
+## Additional Resources
+
+To learn more about Dwolla and how to integrate our product with your application, please consider visiting the following resources and becoming a member of our community!
+
+* [Dwolla](https://www.dwolla.com/)
+* [Dwolla Developers](https://developers.dwolla.com/)
+* [SDKs and Tools](https://developers.dwolla.com/sdks-tools)
+  * [Dwolla SDK for C#](https://github.com/Dwolla/dwolla-v2-csharp)
+  * [Dwolla SDK for Kotlin](https://github.com/Dwolla/dwolla-v2-kotlin)
+  * [Dwolla SDK for Node](https://github.com/Dwolla/dwolla-v2-node)
+  * [Dwolla SDK for PHP](https://github.com/Dwolla/dwolla-v2-php)
+  * [Dwolla SDK for Python](https://github.com/Dwolla/dwolla-v2-python)
+* [Developer Support Forum](https://discuss.dwolla.com/)
+
+

lib/dwolla_v2.rb

@@ -38,7 +38,7 @@
 require "dwolla_v2/errors/temporarily_unavailable_error"
 require "dwolla_v2/errors/unsupported_grant_type_error"
 
-# Dwolla errors https://docsv2.dwolla.com/#errors
+# Dwolla errors https://developers.dwolla.com/api-reference#errors
 require "dwolla_v2/errors/bad_request_error"
 require "dwolla_v2/errors/validation_error"
 require "dwolla_v2/errors/invalid_credentials_error"