Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JAV-42 update the readme #8

Closed
wants to merge 3 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 52 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,52 @@
# service-center [![Build Status](https://travis-ci.org/ServiceComb/service-center.svg?branch=master)](https://travis-ci.org/ServiceComb/service-center)
A standalone service center to allow services to register their instance information and to discover providers of a given service
EDIT1
# Service Center [![Build Status](https://travis-ci.org/ServiceComb/service-center.svg?branch=master)](https://travis-ci.org/ServiceComb/service-center)

A standalone Service Center to allow services to register their instance information and to discover providers of a given service


## Quick Start

### Getting Service Center

The easiest way to get Service Center is to use one of the pre-built release binaries which are available for OSX, Linux, Windows, and Docker. Instructions for using these binaries are on the [GitHub releases page][github-release].

[github-release]: https://github.com/servicecomb/service-center/releases/

### Running Service Center

First, you need to run a etcd(version: 1.3.x) as a database service,and then modify the etcd IP and port in the Service Center configuration file (./conf/app.conf : manager_cluster).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this statement First, you need to run a etcd(version: 1.3.x) as a database service probably belongs to the design of service center.

It's better to put this information to a design section. users just need to know how to start service center in this section.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is not design section. when you start sc, you need run manual etcd .

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay, i misunderstood how the package was made now. but it will be more user friendly to include the etcd in our binary package.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TankTian There is no v1.3.x version in etcd release on github page, is there any misunderstood about the readme?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sorry .misunderstood . it is should v3.x

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@TankTian Can you update the file for it?


```sh
./bin/start.sh
```
This will bring up Service Center listening on port 30100 for service communication.

## Documentation

Project documentation is available on the ServiceComb website.


## Building

You don’t need to build from source to use Service Center (binaries on the [GitHub releases page][github-release]), but if you want to try out the latest and greatest, Service Center can be easily built. You can refer to this compilation script([.travis.yml][travis.yml]).

[github-release]: https://github.com/servicecomb/service-center/releases/
[travis.yml]: https://github.com/ServiceComb/service-center/blob/master/.travis.yml

## Automated Testing


## Contact

Mailing list:

Planning/Roadmap: milestones, roadmap

Bugs: issues

## Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

## Reporting Issues

See reporting bugs for details about reporting any issues.