Documentation updates.

CHANGELOG.md

@@ -8,10 +8,8 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ## [1.7.2](https://github.com/alexdlaird/java-ngrok/compare/1.7.1...1.7.2) - 2023-04-12
 ### Added
 - Support for `basic_auth` parameter in `ngrok` v3.
-- Test improvements.
-
-### Fixed
 - Documentation improvements.
+- Test improvements.
 
 ## [1.7.1](https://github.com/alexdlaird/java-ngrok/compare/1.7.0...1.7.1) - 2023-04-11
 ### Fixed

src/main/java/com/github/alexdlaird/ngrok/NgrokClient.java

@@ -98,7 +98,8 @@
  * <p>
  * <p>
  * <code>java-ngrok</code> is compatible with <code>ngrok</code> v2 and v3, but by default it will install v2. To
- * install v3 instead, set the version with {@link JavaNgrokConfig.Builder#withNgrokVersion(NgrokVersion)}.
+ * install v3 instead, set the version with {@link JavaNgrokConfig.Builder#withNgrokVersion(NgrokVersion)}
+ * and {@link CreateTunnel.Builder#withNgrokVersion(NgrokVersion)}.
  * <p>
  * <strong>Note:</strong> <code>ngrok</code> v2's default behavior for <code>http</code> when no additional properties
  * are passed is to open <em>two</em> tunnels, one <code>http</code> and one <code>https</code>. This method will
@@ -158,6 +159,13 @@ private NgrokClient(final Builder builder) {
      * Establish a new <code>ngrok</code> tunnel for the tunnel definition, returning an object representing
      * the connected tunnel.
      * <p>
+     * If <code>ngrok</code> is not installed at {@link JavaNgrokConfig}'s <code>ngrokPath</code>, calling this method
+     * will first download and install <code>ngrok</code>.
+     * <p>
+     * <code>java-ngrok</code> is compatible with <code>ngrok</code> v2 and v3, but by default it will install v2. To
+     * install v3 instead, set the version with {@link JavaNgrokConfig.Builder#withNgrokVersion(NgrokVersion)}
+     * and {@link CreateTunnel.Builder#withNgrokVersion(NgrokVersion)}.
+     * <p>
      * If <code>ngrok</code> is not running, calling this method will first start a process with
      * {@link JavaNgrokConfig}.
      * <p>

src/main/java/com/github/alexdlaird/ngrok/conf/JavaNgrokConfig.java

@@ -26,6 +26,7 @@
 import com.github.alexdlaird.ngrok.installer.NgrokInstaller;
 import com.github.alexdlaird.ngrok.installer.NgrokVersion;
 import com.github.alexdlaird.ngrok.process.NgrokLog;
+import com.github.alexdlaird.ngrok.protocol.CreateTunnel;
 import com.github.alexdlaird.ngrok.protocol.Region;
 
 import java.nio.file.Path;
@@ -53,6 +54,10 @@
  *         .withJavaNgrokConfig(javaNgrokConfig)
  *         .build();
  * </pre>
+ * <h2><code>ngrok</code> Version Compatibility</h2>
+ * <code>java-ngrok</code> is compatible with <code>ngrok</code> v2 and v3, but by default it will install v2. To
+ * install v3 instead, set the version with {@link JavaNgrokConfig.Builder#withNgrokVersion(NgrokVersion)}
+ * and {@link CreateTunnel.Builder#withNgrokVersion(NgrokVersion)}.
  */
 public class JavaNgrokConfig {
 

src/main/java/com/github/alexdlaird/ngrok/protocol/CreateTunnel.java

@@ -25,6 +25,7 @@
 
 import com.github.alexdlaird.http.HttpClient;
 import com.github.alexdlaird.ngrok.NgrokClient;
+import com.github.alexdlaird.ngrok.conf.JavaNgrokConfig;
 import com.github.alexdlaird.ngrok.installer.NgrokVersion;
 
 import java.util.List;
@@ -53,6 +54,10 @@
  *                                                                 createTunnel,
  *                                                                 Tunnel.class);
  * </pre>
+ * <h2><code>ngrok</code> Version Compatibility</h2>
+ * <code>java-ngrok</code> is compatible with <code>ngrok</code> v2 and v3, but by default it will install v2. To
+ * install v3 instead, set the version with {@link JavaNgrokConfig.Builder#withNgrokVersion(NgrokVersion)}
+ * and {@link CreateTunnel.Builder#withNgrokVersion(NgrokVersion)}.
  */
 public class CreateTunnel {
     private transient final NgrokVersion ngrokVersion;