From e65c0f355d9aeddd4fadba48aeb5402909b19f74 Mon Sep 17 00:00:00 2001 From: S2W Date: Wed, 26 Aug 2020 11:26:40 +0800 Subject: [PATCH] fix typo and doc format of README file (#3688) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 1. It’s a little weird to use Chinese comma in English 2. Fix typo: change 'reposity' to 'repository', 'instance' to 'instances' 3. Format other details of the doc --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 1b22caea070..4e84a0e13c9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ - + # Nacos: Dynamic *Na*ming and *Co*nfiguration *S*ervice @@ -12,25 +12,25 @@ Nacos (official site: [http://nacos.io](http://nacos.io)) is an easy-to-use platform designed for dynamic service discovery and configuration and service management. It helps you to build cloud native applications and microservices platform easily. -Service is a first-class citizen in Nacos. Nacos supports almost all type of services，for example，[Dubbo/gRPC service](https://nacos.io/en-us/docs/use-nacos-with-dubbo.html)、[Spring Cloud RESTFul service](https://nacos.io/en-us/docs/use-nacos-with-springcloud.html) or [Kubernetes service](https://nacos.io/en-us/docs/use-nacos-with-kubernetes.html). +Service is a first-class citizen in Nacos. Nacos supports almost all type of services，for example，[Dubbo/gRPC service](https://nacos.io/en-us/docs/use-nacos-with-dubbo.html), [Spring Cloud RESTFul service](https://nacos.io/en-us/docs/use-nacos-with-springcloud.html) or [Kubernetes service](https://nacos.io/en-us/docs/use-nacos-with-kubernetes.html). Nacos provides four major functions. * **Service Discovery and Service Health Check** - Nacos makes it simple for services to register themselves and to discover other services via a DNS or HTTP interface. Nacos also provides real-time healthchecks of services to prevent sending requests to unhealthy hosts or service instance. + Nacos makes it simple for services to register themselves and to discover other services via a DNS or HTTP interface. Nacos also provides real-time health checks of services to prevent sending requests to unhealthy hosts or service instances. * **Dynamic Configuration Management** - Dynamic Configuration Service allows you to manage configurations of all services in a centralized and dynamic manner across all environments. Nacos eliminates the need to redeploy applications and services when configurations are updated, which makes configuration changes more efficient and agile. + Dynamic Configuration Service allows you to manage configurations of all services in a centralized and dynamic manner across all environments. Nacos eliminates the need to redeploy applications and services when configurations are updated, which makes configuration changes more efficient and agile. * **Dynamic DNS Service** - - Nacos supports weighted routing, making it easier for you to implement mid-tier load balancing, flexible routing policies, flow control, and simple DNS resolution services in the production environment within your data center. It helps you to implement DNS-based service discovery easily and prevent applications from coupling to vendor-specific service discovery APIs. + + Nacos supports weighted routing, making it easier for you to implement mid-tier load balancing, flexible routing policies, flow control, and simple DNS resolution services in the production environment within your data center. It helps you to implement DNS-based service discovery easily and prevent applications from coupling to vendor-specific service discovery APIs. * **Service and MetaData Management** - Nacos provides an easy-to-use service dashboard to help you manage your services metadata, configuration, kubernetes DNS, service health and metrics statistics. + Nacos provides an easy-to-use service dashboard to help you manage your services metadata, configuration, kubernetes DNS, service health and metrics statistics. ## Quick Start @@ -38,10 +38,10 @@ It is super easy to get started with your first project. #### Step 1: Download the binary package -You can download the package from the [latest stable release](https://github.com/alibaba/nacos/releases). +You can download the package from the [latest stable release](https://github.com/alibaba/nacos/releases). -Take release nacos-server-1.0.0.zip for example. -``` +Take release `nacos-server-1.0.0.zip` for example: +```sh unzip nacos-server-1.0.0.zip cd nacos/bin ``` @@ -49,11 +49,11 @@ cd nacos/bin #### Step 2: Start Server On the **Linux/Unix/Mac** platform, run the following command to start server with standalone mode: -``` +```sh sh startup.sh -m standalone ``` -On the **Windows** platform, run the following command to start server with standalone mode. Alternatively, you can also double-click the startup.cmd to run NacosServer. +On the **Windows** platform, run the following command to start server with standalone mode. Alternatively, you can also double-click the `startup.cmd` to run NacosServer. ``` cmd startup.cmd -m standalone ``` @@ -74,7 +74,7 @@ For more details, see [quick-start.](https://nacos.io/en-us/docs/quick-start.htm You can view the full documentation from the [Nacos website](https://nacos.io/en-us/docs/what-is-nacos.html). -All the latest and long-term notice can also be found here from [Github notice issue](https://github.com/alibaba/nacos/labels/notice) +All the latest and long-term notice can also be found here from [Github notice issue](https://github.com/alibaba/nacos/labels/notice). ## Contributing @@ -84,7 +84,7 @@ Contributors are welcomed to join Nacos project. Please check [CONTRIBUTING](./C ## Other Related Project Repositories * [nacos-spring-project](https://github.com/nacos-group/nacos-spring-project) provides the integration functionality for Spring. -* [nacos-group](https://github.com/nacos-group) is the reposity that hosts the eco tools for Nacos, such as SDK, synchronization tool, etc. +* [nacos-group](https://github.com/nacos-group) is the repository that hosts the eco tools for Nacos, such as SDK, synchronization tool, etc. * [spring-cloud-alibaba](https://github.com/spring-cloud-incubator/spring-cloud-alibaba) provides the one-stop solution for application development over Alibaba middleware which includes Nacos. ## Contact