This is an automated email from the ASF dual-hosted git repository.
huxing pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-dubbo.git
The following commit(s) were added to refs/heads/master by this push:
new 175c62e Refactor README.
175c62e is described below
commit 175c62ebcc4d07906844020684515411c3adbe6a
Author: Huxing Zhang <[email protected]>
AuthorDate: Mon Jul 9 18:25:38 2018 +0800
Refactor README.
---
README.md | 150 +++++++++++++++++++++++++++++++++++++++++++++++++++++++-------
1 file changed, 133 insertions(+), 17 deletions(-)
diff --git a/README.md b/README.md
index 22bb446..34156f6 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,144 @@
# Apache Dubbo (incubating) Project
-[](https://travis-ci.org/apache/incubator-dubbo)
-[](https://codecov.io/gh/apache/incubator-dubbo)
-[](https://gitter.im/alibaba/dubbo?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
-
-
-
-Apache Dubbo (incubating) is a high-performance, java based RPC framework
open-sourced by Alibaba. Please visit [dubbo official site
](http://dubbo.incubator.apache.org) for quick start and documentations, as
well as [Wiki](https://github.com/apache/incubator-dubbo/wiki) for news, FAQ,
and release notes.
+Apache Dubbo (incubating) is a high-performance, java based open source RPC
framework. Please visit [official site ](http://dubbo.incubator.apache.org) for
quick start and documentations, as well as
[Wiki](https://github.com/apache/incubator-dubbo/wiki) for news, FAQ, and
release notes.
We are now collecting dubbo user info in order to help us to improve dubbo
better, pls. kindly help us by providing yours on [issue#1012: Wanted: who's
using dubbo](https://github.com/apache/incubator-dubbo/issues/1012), thanks :)
-## Side projects
+## Architecture
+
+
+
+## Features
+
+* Transparent interface based RPC
+* Intelligent load balancing
+* Automatic service registration and discovery
+* High extensibility
+* Runtime traffic routing
+* Visualized service governance
+
+## Getting started
+
+### Maven dependency
+
+```xml
+<dependency>
+ <groupId>com.alibaba</groupId>
+ <artifactId>dubbo</artifactId>
+ <version>2.6.2</version>
+</dependency>
+```
+
+### Defining service interfaces
+
+```java
+package org.apache.dubbo.demo;
+
+public interface DemoService {
+ String sayHello(String name);
+}
+```
+
+### Implement interface in service provider
+
+```java
+package org.apache.dubbo.demo.provider;
+
+import org.apache.dubbo.demo.DemoService;
+
+public class DemoServiceImpl implements DemoService {
+ public String sayHello(String name) {
+ return "Hello " + name;
+ }
+}
+```
+
+### Starting service provider
+
+```java
+package org.apache.dubbo.demo.provider;
+
+import com.alibaba.dubbo.config.ApplicationConfig;
+import com.alibaba.dubbo.config.RegistryConfig;
+import com.alibaba.dubbo.config.ServiceConfig;
+import org.apache.dubbo.demo.GreetingService;
+
+import java.io.IOException;
+
+public class Provider {
+
+ public static void main(String[] args) throws IOException {
+ ServiceConfig<GreetingService> serviceConfig = new
ServiceConfig<GreetingService>();
+ serviceConfig.setApplication(new
ApplicationConfig("first-dubbo-provider"));
+ serviceConfig.setRegistry(new
RegistryConfig("multicast://224.5.6.7:1234"));
+ serviceConfig.setInterface(GreetingService.class);
+ serviceConfig.setRef(new GreetingServiceImpl());
+ serviceConfig.export();
+ System.in.read();
+ }
+}
+```
-* [Dubbo Spring
Boot](https://github.com/apache/incubator-dubbo-spring-boot-project) - Spring
Boot Project for Dubbo.
-* [Dubbo ops](https://github.com/apache/incubator-dubbo-ops) - The reference
implementation for dubbo
ops(dubbo-admin,dubbo-monitor-simple,dubbo-registry-simple,etc.).
-* [Dubbo website](https://github.com/apache/incubator-dubbo-website) - Apache
Dubbo (incubating) documents
-* [Dubbo rpc-jsonrpc](https://github.com/apache/incubator-dubbo-rpc-jsonrpc) -
The Json rpc module of Apache Dubbo (incubating) project
-* [Dubbo feature-test](https://github.com/apache/incubator-dubbo-feature-test)
- Apache Dubbo (incubating) feature test
-* [Dubbo docs](https://github.com/apache/incubator-dubbo-docs) - Apache Dubbo
(incubating) documentation
+### Call remote service in consumer
+
+```java
+package org.apache.dubbo.demo.consumer;
+
+import com.alibaba.dubbo.config.ApplicationConfig;
+import com.alibaba.dubbo.config.ReferenceConfig;
+import com.alibaba.dubbo.config.RegistryConfig;
+import org.apache.dubbo.demo.GreetingService;
+
+public class Consumer {
+ public static void main(String[] args) {
+ ReferenceConfig<GreetingService> referenceConfig = new
ReferenceConfig<GreetingService>();
+ referenceConfig.setApplication(new
ApplicationConfig("first-dubbo-consumer"));
+ referenceConfig.setRegistry(new
RegistryConfig("multicast://224.5.6.7:1234"));
+ referenceConfig.setInterface(GreetingService.class);
+ GreetingService greetingService = referenceConfig.get();
+ System.out.println(greetingService.sayHello("world"));
+ }
+}
+```
+
+### Next steps
-## Links
-* [Developer Mailing
list](https://github.com/apache/incubator-dubbo/issues/1393) - Any questions or
suggestions? Please follow this [mailing list subscription
guide](https://github.com/apache/incubator-dubbo/wiki/Mailing-list-subscription-guide)
to subscribe to ([email protected]) and discuss with us.
-* [Gitter channel](https://gitter.im/alibaba/dubbo) - Online chat room with
Dubbo developers.
* [Dubbo user
manual](http://dubbo.apache.org/#/docs/user/preface/background.md) - How to use
Dubbo and all its features.
* [Dubbo developer guide](http://dubbo.apache.org/#/docs/dev/build.md) - How
to invovle in Dubbo development.
* [Dubbo admin
manual](http://dubbo.apache.org/#/docs/admin/install/provider-demo.md) - How to
admin and manage Dubbo services.
+## Contact
+
+* Mailing list:
[[email protected]](mailto:[[email protected]])
(subscription
[guide](https://github.com/apache/incubator-dubbo/wiki/Mailing-list-subscription-guide))
+* Bugs:
[Issues](https://github.com/apache/incubator-dubbo/issues/new?template=dubbo-issue-report-template.md)
+* Gitter: [Gitter channel](https://gitter.im/alibaba/dubbo)
+* Twitter: [@ApacheDubbo](https://twitter.com/ApacheDubbo)
+
+## Contributing
+
+See
[CONTRIBUTING](https://github.com/apache/incubator-dubbo/blob/master/CONTRIBUTING.md)
for details on submitting patches and the contribution workflow.
+
+## Reporting bugs
+
+See [reporting
bugs](https://github.com/coreos/etcd/blob/master/Documentation/reporting_bugs.md)
for details about reporting any issues.
+
+## Reporting a security vulnerability
+
+Please report security vulnerability to [email protected]
(private mailing list).
+
+## Ecosystem
+
+* [Dubbo website](https://github.com/apache/incubator-dubbo-website) - Apache
Dubbo (incubating) official website
+* [Dubbo samples](https://github.com/dubbo/dubbo-samples) - samples for Apache
Dubbo (incubating)
+* [Dubbo Spring
Boot](https://github.com/apache/incubator-dubbo-spring-boot-project) - Spring
Boot Project for Dubbo
+* [Dubbo ops](https://github.com/apache/incubator-dubbo-ops) - The reference
implementation for dubbo ops (dubbo-admin, dubbo-monitor,
dubbo-registry-simple, etc.)
+
+#### Language
+
+* [Node.js](https://github.com/dubbo/dubbo2.js)
+* [Python](https://github.com/dubbo/dubbo-client-py)
+* [Php](https://github.com/dubbo/dubbo-php-framework)
+
+## License
+
+Apache Dubbo is under the Apache 2.0 license. See the
[LICENSE](https://github.com/apache/incubator-dubbo/blob/master/LICENSE) file
for details.
