Skip to content

Commit

Permalink
Polish apache#395 Update documents
Browse files Browse the repository at this point in the history
  • Loading branch information
@mercyblitz
mercyblitz committed Jan 25, 2019
1 parent 35dd805 commit 1960f86
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 61 deletions.
55 changes: 29 additions & 26 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can introduce the latest `dubbo-spring-boot-starter` to your project by addi
```xml
<properties>
<spring-boot.version>2.1.1.RELEASE</spring-boot.version>
<dubbo.version>2.6.5</dubbo.version>
<dubbo.version>2.7.0-SNAPSHT</dubbo.version>
</properties>

<dependencyManagement>
Expand All @@ -35,15 +35,35 @@ You can introduce the latest `dubbo-spring-boot-starter` to your project by addi
<type>pom</type>
<scope>import</scope>
</dependency>
<!-- Dubbo dependencies -->

<!-- Aapche Dubbo -->
<dependency>
<groupId>com.alibaba</groupId>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-dependencies-bom</artifactId>
<version>${dubbo.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>

<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo</artifactId>
<version>${dubbo.version}</version>
<exclusions>
<exclusion>
<groupId>org.springframework</groupId>
<artifactId>spring</artifactId>
</exclusion>
<exclusion>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
</exclusion>
<exclusion>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
</dependencyManagement>

Expand All @@ -52,16 +72,12 @@ You can introduce the latest `dubbo-spring-boot-starter` to your project by addi
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<version>0.2.1-SNAPSHOT</version>
<version>1.0.0-SNAPSHOT</version>
</dependency>

<dependency>
<groupId>com.alibaba</groupId>
<artifactId>dubbo</artifactId>
<version>${dubbo.version}</version>
</dependency>
<dependency>
<groupId>io.netty</groupId>
<artifactId>netty-all</artifactId>
</dependency>
</dependencies>
```
Expand All @@ -70,8 +86,9 @@ If your project failed to resolve the dependency, try to add the following repos
```xml
<repositories>
<repository>
<id>sonatype-nexus-snapshots</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
<id>apache.snapshots.https</id>
<name>Apache Development Snapshot Repository</name>
<url>https://repository.apache.org/content/repositories/snapshots</url>
<releases>
<enabled>false</enabled>
</releases>
Expand All @@ -83,13 +100,6 @@ If your project failed to resolve the dependency, try to add the following repos
```


## Developing Versions

For now, `dubbo-spring-boot-starter` will separate two versions for Spring Boot 2.x and 1.x once release :

* [`0.2.x`](https://github.com/apache/incubator-dubbo-spring-boot-project) is a main stream release version for Spring Boot 2.x

* [`0.1.x`](https://github.com/apache/incubator-dubbo-spring-boot-project/tree/0.1.x) is a legacy version for maintaining Spring Boot 1.x


### Build from Source
Expand All @@ -100,13 +110,6 @@ If you'd like to attempt to experience latest features, you also can build from
> Maven install = `mvn install`

### Dependencies

| versions | Java | Spring Boot | Dubbo |
| -------- | ----- | ----------- | ---------- |
| `0.2.1` | 1.8+ | `2.1.x` | `2.6.2` + |
| `0.1.1` | 1.7+ | `1.5.x` | `2.6.2` + |



## Getting Started
Expand Down
96 changes: 63 additions & 33 deletions README_CN.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,32 +23,75 @@

您可以为您的工程引入最新 `dubbo-spring-boot-starter` 的发布，增加以下依赖到工程的 `pom.xml` 文件中：
```xml
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<version>0.2.1</version>
</dependency>

<!-- Dubbo -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>dubbo</artifactId>
<version>2.6.5</version>
</dependency>
<!-- Spring Context Extras -->
<dependency>
<groupId>com.alibaba.spring</groupId>
<artifactId>spring-context-support</artifactId>
<version>1.0.2</version>
</dependency>
<properties>
<spring-boot.version>2.1.1.RELEASE</spring-boot.version>
<dubbo.version>2.7.0-SNAPSHT</dubbo.version>
</properties>

<dependencyManagement>
<dependencies>
<!-- Spring Boot -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>${spring-boot.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>

<!-- Aapche Dubbo -->
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-dependencies-bom</artifactId>
<version>${dubbo.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>

<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo</artifactId>
<version>${dubbo.version}</version>
<exclusions>
<exclusion>
<groupId>org.springframework</groupId>
<artifactId>spring</artifactId>
</exclusion>
<exclusion>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
</exclusion>
<exclusion>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
</dependencyManagement>

<dependencies>
<!-- Dubbo Spring Boot Starter -->
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-spring-boot-starter</artifactId>
<version>1.0.0-SNAPSHOT</version>
</dependency>

<dependency>
<groupId>com.alibaba</groupId>
<artifactId>dubbo</artifactId>
</dependency>
</dependencies>
```

如果您的工程遇到了依赖问题, 请尝试添加如下 Maven 参考到工程的 `pom.xml` 文件中：
```xml
<repositories>
<repository>
<id>sonatype-nexus-snapshots</id>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
<id>apache.snapshots.https</id>
<name>Apache Development Snapshot Repository</name>
<url>https://repository.apache.org/content/repositories/snapshots</url>
<releases>
<enabled>false</enabled>
</releases>
Expand All @@ -60,13 +103,6 @@
```


## 开发版本

从现在开始, `dubbo-spring-boot-project` 将在每个发布中发行两个版本 :

* [`0.2.x`](https://github.com/apache/incubator-dubbo-spring-boot-project) 是支持 Spring Boot 2.x 的主要版本（推荐，长期维护）

* [`0.1.x`](https://github.com/apache/incubator-dubbo-spring-boot-project/tree/0.1.x) 是支持 Spring Boot 1.x 的维护版本（兼容，短期维护）


### 源代码构建
Expand All @@ -76,12 +112,6 @@
1. Maven install 当前工程
> Maven install = `mvn install`
### 依赖关系

| 版本 | Java | Spring Boot | Dubbo |
| -------- | ----- | ----------------- | ---------- |
| `0.2.0` | 1.8+ | `2.0.x` | `2.6.2`+ |
| `0.1.1` | 1.7+ | `1.5.x` | `2.6.2`+ |



Expand Down
3 changes: 1 addition & 2 deletions dubbo-spring-boot-parent/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@
<scope>import</scope>
</dependency>

<!-- Dubbo dependencies -->
<!-- Aapche Dubbo -->
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo-dependencies-bom</artifactId>
Expand All @@ -78,7 +78,6 @@
<scope>import</scope>
</dependency>

<!-- Dubbo -->
<dependency>
<groupId>org.apache.dubbo</groupId>
<artifactId>dubbo</artifactId>
Expand Down

0 comments on commit 1960f86

Please sign in to comment.