From 2508daca49a91ad3b896137d0fda144b14803036 Mon Sep 17 00:00:00 2001
From: Ryan Bergman <ryan.bergman@gmail.com>
Date: Mon, 30 Dec 2024 09:16:08 -0600
Subject: [PATCH] clean up the readme so we only have 1 place about
 installation and move the upgrade guide into the main documentation

---
 CHANGELOG.md                                  |  4 +-
 README.md                                     | 58 +------------------
 mkdocs/docs/installation.md                   |  3 +
 .../docs/upgrade-guilde.md                    |  0
 mkdocs/mkdocs.yml                             |  1 +
 5 files changed, 9 insertions(+), 57 deletions(-)
 rename UPGRADE_GUIDE.md => mkdocs/docs/upgrade-guilde.md (100%)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index cf58157a..3e38a019 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -106,7 +106,7 @@ The mock module has had its maven artifact ID changed only.
 * Apache Replaced by native Java HTTP Client
 * Modular Maven config with bom
 * Zero external runtime dependencies by default
-* You MUST include JSON support on your own ([see upgrade guide](UPGRADE_GUIDE.md))
+* You MUST include JSON support on your own ([see upgrade guide](mkdocs/docs/upgrade-guilde))
 * New Maven coordinates
 * New packaging in order to not conflict with older versions
 
@@ -365,7 +365,7 @@ The mock module has had its maven artifact ID changed only.
 * JsonNode now has a ```toPrettyString``` method for getting a formatted json string
 
 ## 3.0.00
-* Replace the dependency on org.json with a native kong.unirest library powered by gson that matches org.json interfaces. See the [Upgrade Guide](UPGRADE_GUIDE.md) for details.
+* Replace the dependency on org.json with a native kong.unirest library powered by gson that matches org.json interfaces. See the [Upgrade Guide](mkdocs/docs/upgrade-guilde) for details.
 * Issue #299. Remove gzip content-encoding header after decompression on async client
 
 ## 2.4.01
diff --git a/README.md b/README.md
index 9a4110bc..3db800eb 100644
--- a/README.md
+++ b/README.md
@@ -11,64 +11,12 @@ Unirest 4 is build on modern Java standards, and as such requires at least Java
 Unirest 4's dependencies are fully modular, and have been moved to new Maven coordinates to avoid conflicts with the previous versions.
 You can use a maven bom to manage the modules:
 
-### Install With Maven
-
-```xml
-<dependencyManagement>
-  <dependencies>
-      <!-- https://mvnrepository.com/artifact/com.konghq/unirest-java-bom --> 
-      <dependency>
-          <groupId>com.konghq</groupId>
-          <artifactId>unirest-java-bom</artifactId>
-          <version>4.4.5</version>
-          <type>pom</type>
-          <scope>import</scope>
-      </dependency>
-  </dependencies>
-</dependencyManagement>
-
-<dependencies>
-    <!-- https://mvnrepository.com/artifact/com.konghq/unirest-java-core -->
-    <dependency>
-        <groupId>com.konghq</groupId>
-        <artifactId>unirest-java-core</artifactId>
-    </dependency>
-    
-    <!-- pick a JSON module if you want to parse JSON include one of these: -->
-    <!-- Google GSON -->
-    <dependency>
-        <groupId>com.konghq</groupId>
-        <artifactId>unirest-modules-gson</artifactId>
-    </dependency>
-
-    <!-- OR maybe you like Jackson better? -->
-    <dependency>
-        <groupId>com.konghq</groupId>
-        <artifactId>unirest-modules-jackson</artifactId>
-    </dependency>
-</dependencies>
-```
-
-#### 🚨 Attention JSON users 🚨
-Under Unirest 4, core no longer comes with ANY transient dependencies, and because Java itself lacks a JSON parser you MUST declare a JSON implementation if you wish to do object mappings or use Json objects.
-
+## Documentation
+Our [Documentation](http://kong.github.io/unirest-java/)
 
 ## Upgrading from Previous Versions 
-See the [Upgrade Guide](UPGRADE_GUIDE.md)
+See the [Upgrade Guide](http://kong.github.io/unirest-java/upgrade-guilde)
 
 ## ChangeLog 
 See the [Change Log](CHANGELOG.md) for recent changes.
 
-## Documentation
-Our [Documentation](http://kong.github.io/unirest-java/) 
-
-## Unirest 3
-### Maven
-```xml
-<!-- Pull in as a traditional dependency -->
-<dependency>
-    <groupId>com.konghq</groupId>
-    <artifactId>unirest-java</artifactId>
-    <version>3.14.1</version>
-</dependency>
-```
diff --git a/mkdocs/docs/installation.md b/mkdocs/docs/installation.md
index 96495f14..3e5b1d59 100644
--- a/mkdocs/docs/installation.md
+++ b/mkdocs/docs/installation.md
@@ -41,6 +41,9 @@ You can use a maven bom to manage the modules:
 </dependencies>
 ```
 
+#### 🚨 Attention JSON users 🚨
+Under Unirest 4, core no longer comes with ANY transient dependencies, and because Java itself lacks a JSON parser you MUST declare a JSON implementation if you wish to do object mappings or use Json objects.
+
 ### Upgrading from Previous Versions
 See the [Upgrade Guide](https://github.com/Kong/unirest-java/blob/master/UPGRADE_GUIDE.md)
 
diff --git a/UPGRADE_GUIDE.md b/mkdocs/docs/upgrade-guilde.md
similarity index 100%
rename from UPGRADE_GUIDE.md
rename to mkdocs/docs/upgrade-guilde.md
diff --git a/mkdocs/mkdocs.yml b/mkdocs/mkdocs.yml
index a5583f98..dbef11a2 100644
--- a/mkdocs/mkdocs.yml
+++ b/mkdocs/mkdocs.yml
@@ -29,6 +29,7 @@ theme:
 nav:
     - About: index.md
     - Installation: installation.md
+    - Upgrade Guide: upgrade-guide.md
     - Configuration: configuration.md
     - Making Requests: requests.md
     - Handling Responses: responses.md