|
1 | 1 | <p align="center"> |
2 | 2 | <img width="40%" src="https://buildbuddy.io/images/header.png?version=1"><br/> |
3 | | - <a href="https://buildbuddy.io">BuildBuddy</a> is an open source Bazel build event viewer<br/><br/> |
| 3 | + <a href="https://buildbuddy.io">BuildBuddy</a> is an open source Bazel build event viewer, result store, and remote cache.<br/><br/> |
4 | 4 | <img src="https://img.shields.io/badge/License-MIT-green.svg" /> |
5 | 5 | <img src="https://img.shields.io/github/workflow/status/buildbuddy-io/buildbuddy/CI" /> |
6 | 6 | </p> |
7 | 7 |
|
8 | 8 | # Intro |
9 | | -BuildBuddy is an open source Bazel build event viewer. It helps you collect, view, share and debug build events in a user-friendly web UI. |
| 9 | +BuildBuddy is an open source Bazel build event viewer, result store, and remote cache. It helps you collect, view, share and debug build events in a user-friendly web UI. |
10 | 10 |
|
11 | 11 | It's written in Golang and React and can be deployed as a Docker image. It's run both as a [cloud hosted service](https://buildbuddy.io) and can be deployed to your cloud provider or run on-prem. BuildBuddy's core is open sourced in this repo under the [MIT License](https://github.com/buildbuddy-io/buildbuddy/blob/master/LICENSE). |
12 | 12 |
|
13 | 13 | # Get started |
14 | 14 |
|
15 | | -Getting started with Buildbuddy is simple. Just add these **two lines** to your `.bazelrc` file. |
| 15 | +Getting started with BuildBuddy is simple. Just add these **two lines** to your `.bazelrc` file. |
16 | 16 |
|
17 | 17 | **.bazelrc** |
18 | 18 | ``` |
19 | 19 | build --bes_results_url=https://app.buildbuddy.io/invocation/ |
20 | 20 | build --bes_backend=grpcs://events.buildbuddy.io:1986 |
21 | 21 | ``` |
22 | 22 |
|
23 | | -This will print a **Buildbuddy url** containing your build results at the beginning and end of every Bazel invocation. You can command click / double click on these to open the results in a browser. |
| 23 | +This will print a **BuildBuddy url** containing your build results at the beginning and end of every Bazel invocation. You can command click / double click on these to open the results in a browser. |
24 | 24 |
|
25 | 25 | **Want more control?** Want to get your whole team set up? Get up and running fast with the cloud hosted [BuildBuddy.io](https://buildbuddy.io) service. |
26 | 26 |
|
27 | | -If you'd like to host your own instance **on-premise** or in the cloud, check out our [getting started](https://github.com/buildbuddy-io/buildbuddy/blob/master/SETUP.md) guide. |
| 27 | +If you'd like to host your own instance **on-prem** or in the cloud, check out our [documentation](https://github.com/buildbuddy-io/buildbuddy/blob/master/docs/introduction.md). |
| 28 | + |
| 29 | +# Documentation |
| 30 | + |
| 31 | +Our [documentation](https://github.com/buildbuddy-io/buildbuddy/blob/master/docs/introduction.md) gives you a full look at how to set up and configure BuildBuddy. |
| 32 | + |
| 33 | +# Questions? |
| 34 | +If you have any questions, e-mail us at [hello@buildbuddy.io](mailto:hello@buildbuddy.io) or join the [BuildBuddy Slack channel](https://join.slack.com/t/buildbuddy/shared_invite/zt-e0cugoo1-GiHaFuzzOYBPQzl9rkUR_g). We’d love to chat! |
28 | 35 |
|
29 | 36 | # Features |
30 | 37 |
|
@@ -58,7 +65,4 @@ If you'd like to host your own instance **on-premise** or in the cloud, check ou |
58 | 65 |  |
59 | 66 |
|
60 | 67 | - **Slack webhook support** - BuildBuddy allows you to message a Slack channel when builds finish. It's a nice way of getting a quick notification when a long running build completes, or a CI build fails. See the [configuration docs](https://github.com/buildbuddy-io/buildbuddy/blob/master/CONFIG.md#integrations) for more information. |
61 | | - |
62 | | - |
63 | | -# Questions? |
64 | | -If you have any questions, e-mail us at [hello@buildbuddy.io](mailto:hello@buildbuddy.io) or join the [BuildBuddy Slack channel](https://join.slack.com/t/buildbuddy/shared_invite/zt-e0cugoo1-GiHaFuzzOYBPQzl9rkUR_g). We’d love to chat! |
| 68 | + |
0 commit comments