adding documentation

This commit is contained in:
Shlomi Noach 2016-05-23 12:32:43 +02:00
parent 493b8512ac
commit 026cd122ba

View File

@ -1,2 +1,19 @@
# gh-ost
GitHub's Online Schema Change for MySQL
# gh-ost: GitHub's online schema migration for MySQL
`gh-ost` allows for online schema migrations in MySQL
## What's in a name?
Originally this was named `gh-osc`: GitHub Online Schema Change, in the likes of [Facebook online schema change](https://www.facebook.com/notes/mysql-at-facebook/online-schema-change-for-mysql/430801045932/) and [pt-online-schema-change](https://www.percona.com/doc/percona-toolkit/2.2/pt-online-schema-change.html).
But then a rare genetic mutation happened, and the `s` transformed into `t`. And that sent us down the path of trying to figure out a new acronym. Right now, `gh-ost` (pronounce: _Ghost_), stands for:
- GitHub Online Schema Translator/Transformer/Transfigurator
## Authors
`gh-ost` was designed, authored, reviewed and tested by the database infrastructure team at GitHub:
- @jonahberquist
- @ggunson
- @tomkrouper
- @shlomi-noach