Skip to content

Commit

Permalink
add xenon documents.
Browse files Browse the repository at this point in the history
Signed-off-by: LiJiansheng <[email protected]>
  • Loading branch information
LiJiansheng committed May 4, 2018
1 parent df7d4ff commit a90a43f
Show file tree
Hide file tree
Showing 5 changed files with 1,176 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
[![Build Status](https://travis-ci.org/radondb/xenon.png)](https://travis-ci.org/radondb/xenon)
[![Go Report Card](https://goreportcard.com/badge/github.com/radondb/xenon)](https://goreportcard.com/report/github.com/radondb/xenon)
[![codecov.io](https://codecov.io/gh/radondb/xenon/graphs/badge.svg)](https://codecov.io/gh/radondb/xenon/branch/master)

# Xenon

![](docs/images/xenon.png)

## Overview

`Xenon` is a MySQL HA and replication management tool using Raft protocol.

* Fast Failover with no lost transactions
* Streaming & Speed-Unmatched backup/restore
* Mysql Operation and Maintenance
* No central control and easy-to-deploy
* As a Cloud App

## Documentation

- [build_and_run](docs/how_to_build_and_run_xenon.md) : How to build and run Xenon.
- [client_commands](docs/xenoncli_commands.md) : Xenon client commands.
- [how_xenon_works](docs/how_xenon_works.md) : How Xenon works.

## Status

Xenon is production ready, it has been used in production like [MySQL Plus](https://www.qingcloud.com/products/mysql-plus/)

## Issues

The [integrated github issue tracker](https://github.com/radondb/xenon/issues)
is used for this project.

## License

Xenon is released under the GPLv3. See [LICENSE](LICENSE)
Loading

0 comments on commit a90a43f

Please sign in to comment.