(opendal) branch main updated: docs: add spring integration configuration doc (#5053)

[ti...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

tison pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opendal.git


The following commit(s) were added to refs/heads/main by this push:
     new cc6df5d97a docs: add spring integration configuration doc (#5053)
cc6df5d97a is described below

commit cc6df5d97a6c72db6b3153de178eb96d46b6c2d6
Author: ZhangJian He <sh...@gmail.com>
AuthorDate: Wed Oct 2 15:33:14 2024 +0800

    docs: add spring integration configuration doc (#5053)
    
    Signed-off-by: ZhangJian He <sh...@gmail.com>
---
 integrations/spring/README.md | 66 ++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 65 insertions(+), 1 deletion(-)

diff --git a/integrations/spring/README.md b/integrations/spring/README.md
index 81ba9d0f93..fa7899b218 100644
--- a/integrations/spring/README.md
+++ b/integrations/spring/README.md
@@ -8,4 +8,68 @@ This project includes three primary modules:
 
 - opendal-spring: Core integration module for [Spring](https://spring.io/) applications.
 - opendal-spring-boot-starter: Synchronous starter for [Spring WebMVC](https://docs.spring.io/spring-framework/reference/web/webmvc.html).
-- opendal-spring-boot-starter-reactor: Asynchronous starter for [Spring WebFlux](https://docs.spring.io/spring-framework/reference/web/webflux.html).
+- opendal-spring-boot-starter-reactive: Asynchronous starter for [Spring WebFlux](https://docs.spring.io/spring-framework/reference/web/webflux.html).
+
+## Features
+
+- SpringBoot autoconfiguration support for an OpenDALTemplate/ReactiveOpenDALTemplate instance.
+
+## Prerequisites
+
+This project requires JDK 17 or later and supports Spring 6 and Spring Boot 3.
+
+## Getting Started With Spring Boot Starter
+
+Below is a brief example demonstrating how to use the OpenGemini Spring Boot Starter in a Java application.
+
+### Maven Configuration
+
+Add the following dependency to your project's `pom.xml`:
+
+```xml
+<dependency>
+    <groupId>org.apache.opendal</groupId>
+    <artifactId>opendal-spring-boot-starter</artifactId>
+    <version>${version}</version>
+</dependency>
+```
+
+### SpringBoot Application Configuration
+
+Following properties can be used in your `application.yaml`:
+
+```yaml
+spring:
+  opendal:
+    schema: "fs"
+    conf:
+      root: "/tmp"
+```
+
+## Getting Started With Spring Boot Reactive Starter
+
+Below is a brief example demonstrating how to use the OpenGemini Spring Boot Starter in a Java application.
+
+### Maven Configuration
+
+Add the following dependency to your project's `pom.xml`:
+
+```xml
+<dependency>
+    <groupId>org.apache.opendal</groupId>
+    <artifactId>opendal-spring-boot-starter-reactive</artifactId>
+    <version>${version}</version>
+</dependency>
+```
+
+### SpringBoot Reactive Application Configuration
+
+Following properties can be used in your `application.yaml`:
+
+```yaml
+spring:
+  opendal:
+    schema: "fs"
+    conf:
+      root: "/tmp"
+```