From 95b24c4ef2f71387982ca477c4ca495f22a42b80 Mon Sep 17 00:00:00 2001 From: Euler Taveira Date: Mon, 26 Aug 2019 12:24:43 -0300 Subject: [PATCH] Initial README version --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 00000000000..9f9614e576c --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# KrahoDB + +KrahoDB is an open-source database designed to support multi-master replication. It is designed on the top of PostgreSQL, providing bidirectional replication, as well as row filtering. + +KrahoDB is a PostgreSQL fork. We provide versions based on PostgreSQL 10 and 11. All code is licensed under PostgreSQL license. + +![Logo](krahodb.png) + +## Installation + +The [installation process](https://www.postgresql.org/docs/current/installation.html) is the same as PostgreSQL. + +Use one of the branches named `krahodb-X-Y` where `X.Y` is the PostgreSQL version (branch `krahodb-10-10` is based on PostgreSQL `10.10`). + +## Usage + +Under construction... + +## Contributing + +Contributions are welcome! + +How can you help us? + +* open an issue + - bug report + - feature request + - suggestion + - portability problem +* submit a pull request + +Before submitting a particular improvement, open an issue to start a discussion about the feature (specially if it is not a trivial change). + +Read the [PostgreSQL Coding Conventions](https://www.postgresql.org/docs/current/source.html). It is what we use for KrahoDB. Also, follow the style of the adjacent code! Remove any spurious whitespace (`git diff --color`). We tend to use underscores or Camelcase (prefer the former). Add useful comments (explain a behavior). Avoid "opens a file" comments. + +KrahoDB uses [PostgreSQL license](http://www.postgresql.org/about/licence/). By posting a patch (issue or pull request), you agree that your patch can be distributed under the PostgreSQL license.