Skip to content

Commit

Permalink
initial readme for oss
Browse files Browse the repository at this point in the history
  • Loading branch information
emaxerrno authored Nov 3, 2020
1 parent 0e2d5ec commit 0414e17
Showing 1 changed file with 70 additions and 0 deletions.
70 changes: 70 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 0414e17

Please sign in to comment.