Skip to content

Commit

Permalink
doc: installation on mac
Browse files Browse the repository at this point in the history
  • Loading branch information
algobot76 committed Apr 4, 2022
1 parent 330e961 commit d426b1e
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
![Test](https://github.com/devstream-io/devstream/actions/workflows/main-builder.yml/badge.svg)
[![Go Report Card](https://goreportcard.com/badge/github.com/devstream-io/devstream)](https://goreportcard.com/report/github.com/devstream-io/devstream)
[![Downloads](https://img.shields.io/github/downloads/devstream-io/devstream/total.svg)](https://github.com/devstream-io/devstream/releases)

# DevStream
</div>

Expand All @@ -18,7 +18,7 @@
TL;DR: DevStream (CLI tool named `dtm`) is an open-source DevOps toolchain manager.

Imagine you are starting a new project or ramping up a new team. Before writing the first line of code, you have to figure out the tools to run an effective SDLC process and from development to deployment.
Imagine you are starting a new project or ramping up a new team. Before writing the first line of code, you have to figure out the tools to run an effective SDLC process and from development to deployment.

Typically, you'd need the following pieces in place to work effectively:

Expand Down Expand Up @@ -78,6 +78,15 @@ Want to remove or reinstall a specific piece in the workflow? DevStream has got
| Observability | devlake | DevLake installation | [doc](./docs/plugins/devlake.md) |
| LDAP | openldap | OpenLDAP installation | [doc](./docs/plugins/openldap.md) |

## Installation

### macOS

Install `dtm` via [Homebrew](https://brew.sh/):

1. Add DevStream's tap to Homebrew: `brew tap devstream-io/devstream`
2. Install `dtm`: `brew install dtm`

## Quick Start

If you want to get a quick start, follow our [quick start](./docs/quickstart_en.md) doc now.
Expand All @@ -86,9 +95,9 @@ If you want to get a quick start, follow our [quick start](./docs/quickstart_en.

DevStream supports the management of many tools. You can flexibly combine some tools to meet the DevOps toolchain your need.

And yes, if you ask me if any recommended practices that can be used out of the box,
And yes, if you ask me if any recommended practices that can be used out of the box,

I am happy to tell you that we have, and we are constantly adding more possible combinations,
I am happy to tell you that we have, and we are constantly adding more possible combinations,

so you are more than welcome to tell us what combinations you expect.

Expand Down Expand Up @@ -135,7 +144,7 @@ Similarly, to delete without confirmation:
```bash
./dtm -y delete -f YOUR_CONFIG_FILE.yaml
```
To delete everything defined in the config, regardless of the state:
To delete everything defined in the config, regardless of the state:

```bash
./dtm delete --force -f YOUR_CONFIG_FILE.yaml
Expand Down
9 changes: 9 additions & 0 deletions docs/README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,15 @@
5. Monitoring - kube-prometheus
6. ……

## 下载

### macOS

通过 [Homebrew](https://brew.sh/) 下载 `dtm`:

1. 添加 DevStream 的 tap: `brew tap devstream-io/devstream`
2. 安装 `dtm`: `brew install dtm`

## 快速开始

如果你想要快速上手体验,可以跳转到我们的[快速开始](./quickstart_zh.md)文档。
Expand Down

0 comments on commit d426b1e

Please sign in to comment.