Skip to content

Commit b761cb4

Browse files
committed
Update readme
1 parent 65c589f commit b761cb4

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,39 @@
44
[![Unit Tests](https://github.com/prequel-dev/preq/actions/workflows/build.yml/badge.svg)](https://github.com/prequel-dev/preq/actions/workflows/build.yml)
55
[![Unit Tests](https://github.com/prequel-dev/prequel-compiler/actions/workflows/build.yml/badge.svg)](https://github.com/prequel-dev/prequel-compiler/actions/workflows/build.yml)
66

7-
`preq` (prounounced "preek") is a free and open community-driven reliability problem detector
7+
preq (prounounced "preek") is a free and open community-driven reliability problem detector
88

99
[Documentation](https://docs.prequel.dev) | [Slack](https://inviter.co/prequel) | [Playground](https://play.prequel.dev/) | [Mailing List](https://www.detect.sh)
1010

1111
---
1212

13-
Use `preq` to:
13+
Use preq to:
1414

1515
- detect the latest bugs, misconfigurations, anti-patterns, and known issues from a community of practitioners
1616
- provide engineers, on-call support, and SRE agents with impact and community recommended mitigations
1717
- hunt for new problems in distributed systems
1818

19-
`preq` is powered by [Common Reliability Enumerations (CREs)](https://github.com/prequel-dev/cre) that are contributed by the community and Prequel's Reliability Research Team. Reliability intelligence helps teams see a broad range of problems earlier, so they can prioritize, pinpoint, and reduce the risk of outages.
19+
preq is powered by [Common Reliability Enumerations (CREs)](https://github.com/prequel-dev/cre) that are contributed by the community and Prequel's Reliability Research Team. Reliability intelligence helps teams see a broad range of problems earlier, so they can prioritize, pinpoint, and reduce the risk of outages.
2020

21-
## Install
21+
## Download and Install
2222

23-
Download the [latest release](https://github.com/prequel-dev/preq/releases) for Linux (amd64), macOS (amd64 and arm64), and Windows (amd64). No configuration is necessary to start using preq.
23+
### Binary Distributions
24+
25+
Official binary distributions are available at [latest release](https://github.com/prequel-dev/preq/releases) for Linux (amd64), macOS (amd64 and arm64), and Windows (amd64). All macOS binaries are signed and notarized. No configuration is necessary to start using preq.
26+
27+
### Kubernetes
28+
29+
You can also install preq as a Krew plugin:
30+
31+
```bash
32+
kubectl krew install preq
33+
```
2434

2535
See https://docs.prequel.dev/install for more information.
2636

2737
## Overview
2838

29-
`preq` is powered by a rules engine that performs distributed matching and correlation of sequences of events across logs, metrics, traces, and other data sources to detect reliability problems. CREs provides accurate and timely context for a human or SRE agent to take action on problems.
39+
preq is powered by a rules engine that performs distributed matching and correlation of sequences of events across logs, metrics, traces, and other data sources to detect reliability problems. CREs provides accurate and timely context for a human or SRE agent to take action on problems.
3040

3141
Below is simple rule that looks for a sequence of events in a single log source over a window of time along with a negative condition (an event that should not occur during the window).
3242

@@ -75,3 +85,10 @@ rule:
7585
```
7686
7787
## Running
88+
89+
* See https://docs.prequel.dev/running for examples of how to run preq
90+
* See https://docs.prequel.dev/running#automated-runbooks for examples of how to setup automated runbooks when a CRE is detected
91+
92+
## Contributing
93+
94+
Open a PR and let's go!

0 commit comments

Comments
 (0)