Skip to content

Commit

Permalink
doc/md: add homebrew installation instructions to docs (#593)
Browse files Browse the repository at this point in the history
  • Loading branch information
rotemtam authored Feb 21, 2022
1 parent f8eaeba commit bcedf13
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 16 deletions.
15 changes: 2 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,12 @@ be used individually but are designed to work very well together.

## Quick Installation

Download latest release.
```shell
curl -LO https://release.ariga.io/atlas/atlas-darwin-amd64-latest
```
On macOS:

Make the atlas binary executable.
```shell
chmod +x ./atlas-darwin-amd64-latest
brew install ariga/tap/atlas
```

Move the atlas binary to a file location on your system PATH.
```shell
sudo mv ./atlas-darwin-amd64-latest /usr/local/bin/atlas
```
```shell
sudo chown root: /usr/local/bin/atlas
```
Instructions for other platforms and databases: [Getting Started](https://atlasgo.io/).

## Getting Started
Expand Down
16 changes: 13 additions & 3 deletions doc/md/getting-started/01-introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,23 @@ the schema of a local database that we will run inside a Docker container.
### Install the CLI

<Tabs
defaultValue="apple-intel"
defaultValue="apple-intel-brew"
values={[
{label: 'MacOS', value: 'apple-intel'},
{label: 'macOS (Homebrew)', value: 'apple-intel-brew'},
{label: 'macOS (Plain)', value: 'apple-intel-plain'},
{label: 'Linux', value: 'linux'},
{label: 'Windows', value: 'windows'},
]}>
<TabItem value="apple-intel">
<TabItem value="apple-intel-brew">

Get the latest release with [Homebrew](https://brew.sh/):

```shell
brew install ariga/tap/atlas
```

</TabItem>
<TabItem value="apple-intel-plain">

Download latest release.
```shell
Expand Down

0 comments on commit bcedf13

Please sign in to comment.