Skip to content

Commit

Permalink
add doc
Browse files Browse the repository at this point in the history
  • Loading branch information
flike committed Sep 13, 2015
1 parent a8b340d commit ab20268
Show file tree
Hide file tree
Showing 2 changed files with 485 additions and 11 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,35 @@
[![Build Status](https://travis-ci.org/flike/kingshard.svg?branch=master)](https://travis-ci.org/flike/kingshard)

#Overview
# Overview
kingshard is a high-performance proxy for MySQL powered by Go. Just like other mysql proxies, you can use it to split the read/write sqls. Now it supports basic SQL statements (select, insert, update, replace, delete). The most important feature is the sharding function. Kingshard aims to simplify the sharding solution of MySQL.

#Feature
# Feature
- splits reads and writes
- sharding table across multiple nodes
- client's ip ACL control.
- transaction in single node.
- supports prepared statement: COM_STMT_PREPARE, COM_STMT_EXECUTE, etc.
- MySQL HA

#Install
1. Install Go
2. git clone https://github.com/flike/kingshard.git src/github.com/flike/kingshard
3. cd src/github.com/flike/kingshard
4. source ./dev.sh
5. make
6. set the config file (etc/multi.yaml)
7. run kingshard (./bin/kingshard -config=etc/multi.yaml)
# Install
```
1. Install Go
2. git clone https://github.com/flike/kingshard.git src/github.com/flike/kingshard
3. cd src/github.com/flike/kingshard
4. source ./dev.sh
5. make
6. set the config file (etc/multi.yaml)
7. run kingshard (./bin/kingshard -config=etc/multi.yaml)
```

# Details of kingshard

[1.How to use kingshard building a MySQL cluster](./doc/KingDoc/how_to_use_kingshard_EN.md)

# License

kingshard is under the MIT license. See the [LICENSE](./doc/License) directory for details.

#Other language version
# Other language version

[简体中文](README_ZH.md)
Loading

0 comments on commit ab20268

Please sign in to comment.