From a74d8af339624fe96648fff661da2525261cdcba Mon Sep 17 00:00:00 2001 From: flystar32 Date: Wed, 7 Nov 2018 20:37:40 +0800 Subject: [PATCH] update readme --- README-zh.md | 6 +++++- README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 50 insertions(+), 2 deletions(-) diff --git a/README-zh.md b/README-zh.md index 72a20fc65..06732dba4 100644 --- a/README-zh.md +++ b/README-zh.md @@ -73,7 +73,11 @@ Spring Cloud 使用 Maven 来构建,最快的使用方式是将本项目clone ### Reference Doc -[文档地址](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/tree/master/spring-cloud-alibaba-docs/src/main/asciidoc-zh) +[目录](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/blob/master/spring-cloud-alibaba-docs/src/main/asciidoc-zh/spring-cloud-alibaba.adoc) + +[Nacos Config](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/blob/master/spring-cloud-alibaba-docs/src/main/asciidoc-zh/nacos-config.adoc) + +[ACM](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/blob/master/spring-cloud-alibaba-docs/src/main/asciidoc-zh/acm.adoc) ## 演示 Demo diff --git a/README.md b/README.md index c69092a13..c70bd1f18 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,51 @@ Spring Cloud uses Maven for most build-related activities, and you should be abl ./mvnw install -## How to use +## How to Use + +### Add maven dependency +Version 0.2.0.RELEASE is compatible with the Spring Boot 2.0.x line. Version 0.1.0.RELEASE is compatible with the Spring Boot 1.x line. + +These artifacts are available from Maven Central and Spring Release repository via BOM: + + + + + org.springframework.cloud + spring-cloud-alibaba-dependencies + 0.2.0.REALEASE + pom + import + + + + +add the module in `dependencies`. + +If you want to use the latest BUILD-SNAPSHOT version, add `Spring Snapshot Repository` in pom.xml , **Attention: BUILD-SNAPSHOT may be updated in any time** + + + + spring-snapshot + Spring Snapshot Repository + https://repo.spring.io/snapshot + + true + + + + + +### Reference Doc + +[Contents](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/blob/master/spring-cloud-alibaba-docs/src/main/asciidoc-zh/spring-cloud-alibaba.adoc) + +[Nacos Config](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/blob/master/spring-cloud-alibaba-docs/src/main/asciidoc-zh/nacos-config.adoc) + +[ACM](https://github.com/spring-cloud-incubator/spring-cloud-alibaba/blob/master/spring-cloud-alibaba-docs/src/main/asciidoc-zh/acm.adoc) + + +## Examples A `spring-cloud-alibaba-examples` module is included in our project for you to get started with Spring Cloud Alibaba quickly. It contains an example, and you can refer to the readme file in the example project for a quick walkthrough.