Merge pull request #22 from EasyPost/v0.5.0

chore: prepare v0.5.0 for release

Author: Justintime50

CHANGELOG.md

@@ -1,16 +1,16 @@
 # CHANGELOG
 
-## Next Release
+## v0.5.0 (2022-12-20)
 
-- [ADDED] Ability to censor parts of a URL path using regex patterns.
+- Adds the ability to censor parts of a URL path using regex patterns.
 
 ## v0.4.2 (2022-10-20)
 
 - Fix a bug where the error data of a bad HTTP request (4xx or 5xx) was not stored as expected in cassettes, causing
   empty error streams on replay.
-    - Error data for a bad HTTP request is now stored as the "body" in the cassette just like a good HTTP request
+  - Error data for a bad HTTP request is now stored as the "body" in the cassette just like a good HTTP request
       would, rather than needlessly stored in a separate "error" key. This more closely matches the behavior of EasyVCR C#.
-    - This is a breaking change for previously-recorded "error" cassettes, which will no longer replay as expected and
+  - This is a breaking change for previously-recorded "error" cassettes, which will no longer replay as expected and
       will need to be re-recorded (although likely never worked as expected in the first place).
 - Fix a bug where using any expiration time frame other than "forever" and "never" would throw a NullPointerException.
 

README.md

@@ -2,12 +2,34 @@
 
 [![CI](https://github.com/EasyPost/easyvcr-java/workflows/CI/badge.svg)](https://github.com/EasyPost/easyvcr-java/actions?query=workflow%3ACI)
 [![Coverage Status](https://coveralls.io/repos/github/EasyPost/easyvcr-java/badge.svg?branch=main)](https://coveralls.io/github/EasyPost/easyvcr-java?branch=main)
-[![Maven Central](https://img.shields.io/maven-central/v/com.easypost/easyvcr?label=Maven%20Central)](https://search.maven.org/artifact/com.easypost/easyvcr)
+[![Maven Central](https://img.shields.io/maven-central/v/com.easypost/easyvcr?label=Maven%20Central)](https://central.sonatype.dev/search?q=easyvcr)
 
 EasyVCR is a library for recording and replaying HTTP interactions in your test suite.
 
 This can be useful for speeding up your test suite, or for running your tests on a CI server which doesn't have connectivity to the HTTP endpoints you need to interact with.
 
+## Install
+
+### Maven
+
+Add this to your project's POM:
+
+```xml
+<dependency>
+  <groupId>com.easypost</groupId>
+  <artifactId>easyvcr</artifactId>
+  <version>0.5.0</version>
+</dependency>
+```
+
+### Gradle
+
+Add this to your project's build file:
+
+```groovy
+implementation "com.easypost:easyvcr:0.5.0"
+```
+
 ## Supported HTTP Clients
 
 - Java 8's [HttpUrlConnection](https://docs.oracle.com/javase/8/docs/api/java/net/HttpURLConnection.html)
@@ -94,6 +116,7 @@ Now when tests are run, no real HTTP calls will be made. Instead, the HTTP respo
 Censor sensitive data in the request and response, such as API keys and auth tokens.
 
 Can censor:
+
 - Request and response headers (via key name)
 - Request and response bodies (via key name) (JSON only)
 - Request query parameters (via key name)

VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

pom.xml

@@ -1,13 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
     <groupId>com.easypost</groupId>
     <artifactId>easyvcr</artifactId>
 
-    <version>0.4.2</version>
+    <version>0.5.0</version>
     <packaging>jar</packaging>
 
     <name>com.easypost:easyvcr</name>