From 0414e177e32f2ec565a7a71f75e68e46303ce0cf Mon Sep 17 00:00:00 2001 From: Alexander Gallego Date: Mon, 2 Nov 2020 18:15:43 -0800 Subject: [PATCH] initial readme for oss --- README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 000000000000..5a80b88a78a1 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +# Redpanda + +Redpanda is a modern streaming platform for mission critical workloads. Kafka® compatible, +No Zookeeper®, no JVM, and no code changes required. Use all your favorite open source tooling - 10x faster. + +Our goal is to empower every developer to supercharge their applications with real-time streaming. +From solo JS devs to enterprise data engineers- we've got your back. +We're building the future of streaming. Whether it's providing inline WASM transforms for one-shot +transformations or helping with tiered hierarchical storage to unify real-time and historical data, +we're pushing the boundaries of what's possible with streaming. + + +# Community + +[Slack](vectorized.io/slack) is the main way the community interacts with one another in real time :) + +[User mailing list](https://groups.google.com/a/vectorized.io/forum/#!forum/redpanda-users/new) is preferred for longer, async, thoughtful discussions + +[GitHub Issues](https://github.com/vectorizedio/redpanda/issues) is reserved only for actual issues. Please use the mailing list for discussions. + +[Code of conduct](./code-of-conduct.md) + +# Getting Started + +## Prebuilt Packages + +We recommend using our free & prebuilt stable releases below. + +### On MacOS + +Simply download our `rpk` binary [here]. We require docker on MacOS + +``` +rpk container start +``` + +### On Debian/Ubuntu + +``` +curl -1sLf \ + 'https://packages.vectorized.io/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.deb.sh' \ + | sudo -E bash + +apt-get install redpanda +``` + +### On Fedora/RedHat/Amazon Linux + +``` +curl -1sLf \ + 'https://packages.vectorized.io/nzc4ZYQK3WRGd9sy/redpanda/cfg/setup/bash.rpm.sh' \ + | sudo -E bash + +yum install redpanda +``` + +## Build Manually + +We provide a very simple build system that uses your system libraries. We recommend +users leverage our pre-built stable releases which are vetted, tested, and reproducible with exact +versions of the entire transitive dependency graph, including exact compilers +all built from source. The only thing we do not build yet is the Linux Kernel, but soon! + +For hackers, here is the short and sweet: + +``` +./install-dependencies.sh && ./build.sh +``` + +See the [contributing docs](./CONTRIBUTING.md)