Skip to content

Commit

Permalink
clean up the readme so we only have 1 place about installation and mo…
Browse files Browse the repository at this point in the history
…ve the upgrade guide into the main documentation
  • Loading branch information
ryber committed Dec 30, 2024
1 parent c55bd2c commit 2508dac
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 57 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down
58 changes: 3 additions & 55 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
```
3 changes: 3 additions & 0 deletions mkdocs/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
File renamed without changes.
1 change: 1 addition & 0 deletions mkdocs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 2508dac

Please sign in to comment.