diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c74b319..9163345 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,7 +50,7 @@ We welcome direct contributions to the java-http-client code base. Thank you! ##### Prerequisites ##### - Java 8 or 11 -- Please see [build.gradle](https://github.com/sendgrid/java-http-client/blob/master/build.gradle) +- Please see [pom.xml](pom.xml) ##### Initial setup: ##### @@ -61,7 +61,7 @@ cd java-http-client ##### Execute: ##### -See the [examples folder](https://github.com/sendgrid/java-http-client/tree/master/examples) to get started quickly. +See the [examples folder](examples) to get started quickly. You will need to setup the following environment to use the SendGrid example: @@ -105,9 +105,9 @@ Provides a standard interface to an API's response. All PRs require passing tests before the PR will be reviewed. -All test files are in [`java-http-client/src/test/java/com/sendgrid`](https://github.com/sendgrid/java-http-client/tree/master/src/test/java/com/sendgrid). +All test files are in [`java-http-client/src/test/java/com/sendgrid`](src/test/java/com/sendgrid). -For the purposes of contributing to this repo, please update the [`ClientTest.java`](https://github.com/sendgrid/java-http-client/blob/master/src/test/java/com/sendgrid/ClientTest.java) file with unit tests as you modify the code. +For the purposes of contributing to this repo, please update the [`ClientTest.java`](src/test/java/com/sendgrid/ClientTest.java) file with unit tests as you modify the code. Run the tests: @@ -168,7 +168,7 @@ Please run your code through: 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: @@ -178,7 +178,7 @@ Please run your code through: ``` 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. ## Code Reviews If you can, please look at open PRs and review them. Give feedback and help us merge these PRs much faster! If you don't know how, GitHub has some great [information on how to review a Pull Request](https://help.github.com/articles/about-pull-request-reviews/). diff --git a/README.md b/README.md index 7a5ac84..b153a13 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) -[![Build Status](https://travis-ci.org/sendgrid/java-http-client.svg?branch=master)](https://travis-ci.org/sendgrid/java-http-client) +[![Build Status](https://travis-ci.org/sendgrid/java-http-client.svg?branch=main)](https://travis-ci.org/sendgrid/java-http-client) [![Maven Central](https://img.shields.io/maven-central/v/com.sendgrid/java-http-client.svg)](http://mvnrepository.com/artifact/com.sendgrid/java-http-client) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md) [![Twitter Follow](https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow)](https://twitter.com/sendgrid) @@ -25,7 +25,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 project are documented in our [CHANGELOG](https://github.com/sendgrid/java-http-client/blob/master/CHANGELOG.md). +All updates to this project are documented in our [CHANGELOG](CHANGELOG.md). # Installation @@ -67,7 +67,7 @@ repositories { ## Dependencies -- Please see the [build.gradle file](https://github.com/sendgrid/java-http-client/blob/master/build.gradle) +- Please see the [pom.xml file](pom.xml) # Quick Start @@ -124,7 +124,7 @@ If you are interested in the future direction of this project, please take a loo # How to Contribute -We encourage contribution to our projects please see our [CONTRIBUTING](https://github.com/sendgrid/java-http-client/blob/master/CONTRIBUTING.md) guide for details. +We encourage contribution to our projects please see our [CONTRIBUTING](CONTRIBUTING.md) guide for details. Quick links: diff --git a/USAGE.md b/USAGE.md index c3a9ad1..4a01093 100644 --- a/USAGE.md +++ b/USAGE.md @@ -1,6 +1,6 @@ # Usage -- [Example Code](https://github.com/sendgrid/java-http-client/tree/master/examples) +- [Example Code](examples) The example uses SendGrid, you can get your free account [here](https://sendgrid.com/free?source=java-http-client). diff --git a/docker/Dockerfile b/docker/Dockerfile index 79a5b0b..5e2749f 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -1,13 +1,13 @@ FROM store/oracle/serverjre:8 -ENV OAI_SPEC_URL="https://raw.githubusercontent.com/sendgrid/sendgrid-oai/master/oai_stoplight.json" +ENV OAI_SPEC_URL="https://raw.githubusercontent.com/sendgrid/sendgrid-oai/HEAD/oai_stoplight.json" RUN yum install -y git WORKDIR /root # install Prism -ADD https://raw.githubusercontent.com/stoplightio/prism/master/install.sh install.sh +ADD https://raw.githubusercontent.com/stoplightio/prism/HEAD/install.sh install.sh RUN chmod +x ./install.sh && sync && \ ./install.sh && \ rm ./install.sh diff --git a/docker/README.md b/docker/README.md index 3af57b8..fabe4c0 100644 --- a/docker/README.md +++ b/docker/README.md @@ -1,5 +1,5 @@ # Supported tags and respective `Dockerfile` links - - `v1.0.0`, `latest` [(Dockerfile)](https://github.com/sendgrid/java-http-client/blob/master/docker/Dockerfile) + - `v1.0.0`, `latest` [(Dockerfile)](Dockerfile) # Quick reference Due to Oracle's JDK license, you must build this Docker image using the official Oracle image located in the Docker Store. You will need a Docker store account. Once you have an account, you must accept the Oracle license [here](https://store.docker.com/images/oracle-serverjre-8). On the command line, type `docker login` and provide your credentials. You may then build the image using this command `docker build -t sendgrid/java-http-client -f Dockerfile .` @@ -11,7 +11,7 @@ Due to Oracle's JDK license, you must build this Docker image using the official https://github.com/sendgrid/java-http-client/issues - **Where to get more info:** - [USAGE.md](https://github.com/sendgrid/java-http-client/blob/master/docker/USAGE.md) + [USAGE.md](USAGE.md) - **Maintained by:** [SendGrid Inc.](https://sendgrid.com) @@ -26,6 +26,6 @@ Due to Oracle's JDK license, you must build this Docker image using the official $ docker run -it -v /path/to/cool-java-http-client:/mnt/java-http-client sendgrid/java-http-client ``` -For more detailed information, see [USAGE.md](https://github.com/sendgrid/java-http-client/blob/master/docker/USAGE.md). +For more detailed information, see [USAGE.md](USAGE.md). ![SendGrid Logo](https://uiux.s3.amazonaws.com/2016-logos/email-logo%402x.png) diff --git a/pom.xml b/pom.xml index ff7fb89..cebd4ce 100644 --- a/pom.xml +++ b/pom.xml @@ -16,7 +16,7 @@ The MIT License (MIT) - https://github.com/sendgrid/java-http-client/blob/master/LICENSE.md + https://github.com/sendgrid/java-http-client/blob/HEAD/LICENSE.md repo 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