From 84f934c7f365369351156c4048caddf5c1721083 Mon Sep 17 00:00:00 2001 From: Kaitian Xie Date: Wed, 6 Apr 2022 10:25:56 +0800 Subject: [PATCH] doc: installation on mac (#385) * doc: installation on mac Co-authored-by: Tiexin Guo --- README.md | 19 ++++++++++++++----- docs/README_zh.md | 9 +++++++++ 2 files changed, 23 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 50a2100ec..8d19c9ed0 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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: @@ -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 devstream-io/devstream/dtm` + ## Quick Start If you want to get a quick start, follow our [quick start](./docs/quickstart_en.md) doc now. @@ -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. @@ -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 diff --git a/docs/README_zh.md b/docs/README_zh.md index cac4f8737..3898bb65c 100644 --- a/docs/README_zh.md +++ b/docs/README_zh.md @@ -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 devstream-io/devstream/dtm` + ## 快速开始 如果你想要快速上手体验，可以跳转到我们的[快速开始](./quickstart_zh.md)文档。