Skip to content

Commit ea802c1

Browse files
committed
Update README
1 parent 563bad6 commit ea802c1

File tree

5 files changed

+13
-9
lines changed

5 files changed

+13
-9
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# HttpExchange Spring Boot Starter [![Build](https://img.shields.io/github/actions/workflow/status/DanielLiu1123/httpexchange-spring-boot-starter/build.yml?branch=main)](https://github.com/DanielLiu1123/httpexchange-spring-boot-starter/actions) [![Maven Central](https://img.shields.io/maven-central/v/io.github.danielliu1123/httpexchange-spring-boot-starter)](https://search.maven.org/artifact/io.github.danielliu1123/httpexchange-spring-boot-starter) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
22

3-
[Documentation](https://danielliu1123.github.io/httpexchange-spring-boot-starter/)
4-
53
Spring 6 now directly supports creating HTTP clients with the [`@HttpExchange`](https://docs.spring.io/spring-framework/reference/integration/rest-clients.html#rest-http-interface) annotation.
64
This means you can use Spring instead of needing [Spring Cloud OpenFeign](https://github.com/spring-cloud/spring-cloud-openfeign).
75

@@ -17,7 +15,7 @@ The main goals of this project:
1715
- Add dependency:
1816

1917
```groovy
20-
implementation("io.github.danielliu1123:httpexchange-spring-boot-starter:3.3.2")
18+
implementation("io.github.danielliu1123:httpexchange-spring-boot-starter:<latest>")
2119
```
2220
2321
- Write a classic Spring Boot application:
@@ -43,6 +41,12 @@ The main goals of this project:
4341
}
4442
```
4543
44+
Refer to [quick-start](https://github.com/DanielLiu1123/httpexchange-spring-boot-starter/tree/main/examples/quick-start).
45+
46+
## Documentation
47+
48+
Go to [Reference Documentation](https://danielliu1123.github.io/httpexchange-spring-boot-starter/docs/intro) for more information.
49+
4650
## Code of Conduct
4751
4852
This project is governed by the [Code of Conduct](./CODE_OF_CONDUCT.md).

website/docs/01-intro.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,15 +81,15 @@ The main goals of this project:
8181
<Tabs>
8282
<TabItem value="gradle" label="Gradle">
8383
```groovy
84-
implementation("io.github.danielliu1123:httpexchange-spring-boot-starter:3.3.2")
84+
implementation("io.github.danielliu1123:httpexchange-spring-boot-starter:<latest>")
8585
```
8686
</TabItem>
8787
<TabItem value="maven" label="Maven">
8888
```xml
8989
<dependency>
9090
<groupId>io.github.danielliu1123</groupId>
9191
<artifactId>httpexchange-spring-boot-starter</artifactId>
92-
<version>3.3.2</version>
92+
<version>latest</version>
9393
</dependency>
9494
```
9595
</TabItem>

website/docs/10-core/20-generate-server-implementation.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Generate default implementation for server, you can use the base implementation
1515
<Tabs>
1616
<TabItem value="gradle" label="Gradle">
1717
```groovy
18-
annotationProcessor("io.github.danielliu1123:httpexchange-processor:3.3.2")
18+
annotationProcessor("io.github.danielliu1123:httpexchange-processor:latest")
1919
```
2020
</TabItem>
2121
<TabItem value="maven" label="Maven">
@@ -27,7 +27,7 @@ Generate default implementation for server, you can use the base implementation
2727
<path>
2828
<groupId>io.github.danielliu1123</groupId>
2929
<artifactId>httpexchange-processor</artifactId>
30-
<version>3.3.2</version>
30+
<version>latest</version>
3131
</path>
3232
</annotationProcessorPaths>
3333
</configuration>

website/docs/40-configuration-properties.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ This page was generated by [spring-configuration-property-documenter](https://gi
4141
|---|----|-----------|-------------|-----------|
4242
| enabled| java.lang.Boolean| Whether to enable refresh exchange clients, default \{@code false}. &lt;p&gt; This feature needs \{@code spring-cloud-context} dependency in the classpath. &lt;p color&#x3D;&quot;orange&quot;&gt; NOTE: This feature is not supported by native image. @see &lt;a href&#x3D;&quot;https://github.com/spring-cloud/spring-cloud-release/wiki/AOT-transformations-and-native-image-support#refresh-scope&quot;&gt;Refresh Scope&lt;/a&gt;| false| |
4343

44-
This is a generated file, generated at: **2024-09-21T17:01:28.408478**
44+
This is a generated file, generated at: **2024-09-21T17:18:08.183478**

website/docs/50-version.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ sidebar_position: 50
66

77
| Spring Boot | httpexchange-spring-boot-starter |
88
|-------------|----------------------------------|
9-
| 3.3.x | 3.3.2 |
9+
| 3.3.x | 3.3.3 |
1010
| 3.2.x | 3.2.5 |
1111
| 3.1.x | 3.1.8 |

0 commit comments

Comments
 (0)