diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 607ac30..0a9b2f4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -72,7 +72,7 @@ source ./sendgrid.env ##### Execute: ##### -See the [examples folder](https://github.com/sendgrid/ruby-http-client/tree/master/examples) to get started quickly. +See the [examples folder](examples) to get started quickly. To run the example (after updating the emails): @@ -89,20 +89,20 @@ Working examples that demonstrate usage. **ruby_http_client.rb** -An HTTP client with a fluent interface using method chaining and reflection. By returning self on [method_missing](https://github.com/sendgrid/ruby-http-client/blob/master/lib/ruby_http_client.rb#L209) and [_()](https://github.com/sendgrid/ruby-http-client/blob/master/lib/ruby_http_client.rb#L194), we can dynamically build the URL using method chaining and [method_missing](https://github.com/sendgrid/ruby-http-client/blob/master/lib/ruby_http_client.rb#L209) allows us to dynamically receive the method calls to achieve reflection. +An HTTP client with a fluent interface using method chaining and reflection. By returning self on [method_missing](lib/ruby_http_client.rb#L209) and [_()](lib/ruby_http_client.rb#L194), we can dynamically build the URL using method chaining and [method_missing](lib/ruby_http_client.rb#L209) allows us to dynamically receive the method calls to achieve reflection. This allows for the following mapping from a URL to a method chain: -`/api_client/{api_key_id}/version` maps to `client.api_client._(api_key_id).version.()` where is a [HTTP verb](https://github.com/sendgrid/ruby-http-client/blob/master/lib/ruby_http_client.rb#L38). +`/api_client/{api_key_id}/version` maps to `client.api_client._(api_key_id).version.()` where is a [HTTP verb](lib/ruby_http_client.rb#L38). ## Testing All PRs require passing tests before the PR will be reviewed. -All test files are in the [`test`](https://github.com/sendgrid/ruby-http-client/tree/master/test) directory. +All test files are in the [`test`](test) directory. -For the purposes of contributing to this repo, please update the [`test_ruby_http_client.rb`](https://github.com/sendgrid/ruby-http-client/blob/master/test/test_ruby_http_client.rb) file with unit tests as you modify the code. +For the purposes of contributing to this repo, please update the [`test_ruby_http_client.rb`](test/test_ruby_http_client.rb) file with unit tests as you modify the code. To run the tests: diff --git a/README.md b/README.md index 680a712..740303e 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png) +![SendGrid Logo](twilio_sendgrid_logo.png) -[![BuildStatus](https://travis-ci.org/sendgrid/ruby-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/ruby-http-client) +[![BuildStatus](https://travis-ci.org/sendgrid/ruby-http-client.svg?branch=main)](https://travis-ci.org/sendgrid/ruby-http-client) [![Email Notifications Badge](https://dx.sendgrid.com/badge/ruby)](https://dx.sendgrid.com/newsletter/ruby) [![Gem Version](https://badge.fury.io/rb/ruby_http_client.svg)](https://badge.fury.io/rb/ruby_http_client) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md) @@ -14,7 +14,7 @@ If you are looking for the SendGrid API client library, please see [this repo](h # Announcements **The default branch name for this repository has been changed to `main` as of 07/27/2020.** -All updates to this library are documented in our [CHANGELOG](https://github.com/sendgrid/ruby-http-client/blob/master/CHANGELOG.md). +All updates to this library are documented in our [CHANGELOG](CHANGELOG.md). # Table of Contents - [Installation](#installation) @@ -85,7 +85,7 @@ puts response.headers # Usage -- [Example Code](https://github.com/sendgrid/ruby-http-client/tree/master/examples) +- [Example Code](examples) # Roadmap @@ -95,14 +95,14 @@ If you are interested in the future direction of this project, please take a loo # How to Contribute -We encourage contribution to our libraries, please see our [CONTRIBUTING](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md) guide for details. +We encourage contribution to our libraries, please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details. Quick links: -- [Feature Request](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#feature-request) -- [Bug Reports](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#submit-a-bug-report) -- [Improvements to the Codebase](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#improvements-to-the-codebase) -- [Review Pull Requests](https://github.com/sendgrid/ruby-http-client/blob/master/CONTRIBUTING.md#code-reviews) +- [Feature Request](CONTRIBUTING.md#feature-request) +- [Bug Reports](CONTRIBUTING.md#submit-a-bug-report) +- [Improvements to the Codebase](CONTRIBUTING.md#improvements-to-the-codebase) +- [Review Pull Requests](CONTRIBUTING.md#code-reviews) # About diff --git a/first-timers.md b/first-timers.md index 9ccebc6..926366e 100644 --- a/first-timers.md +++ b/first-timers.md @@ -55,7 +55,7 @@ We label our issues according to their difficulty level. You can find easy ones 5. Locally merge (or rebase) the upstream development branch into your topic branch: ```bash - git pull [--rebase] upstream master + git pull [--rebase] upstream main ``` 6. Push your topic branch up to your fork: @@ -65,4 +65,4 @@ We label our issues according to their difficulty level. You can find easy ones ``` 7. [Open a Pull Request](https://help.github.com/articles/using-pull-requests/) - with a clear title and description against the `master` branch. All tests must be passing before we will review the PR. + with a clear title and description against the `main` branch. All tests must be passing before we will review the PR. diff --git a/twilio_sendgrid_logo.png b/twilio_sendgrid_logo.png new file mode 100644 index 0000000..a4c2223 Binary files /dev/null and b/twilio_sendgrid_logo.png differ