Skip to content

Commit

Permalink
chore: add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
dhth committed Mar 3, 2024
1 parent 81ba8b9 commit 9dff56d
Showing 1 changed file with 24 additions and 4 deletions.
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,22 @@ one deployment environment but not on others. 🤷
<img src="./outtasync.gif?raw=true" alt="Usage" />
</p>


Install
---

**homebrew**:

```sh
brew install dhth/tap/outtasync
```

**go**:

```sh
go install github.com/dhth/outtasync@latest
```

🛠️ Pre-requisites
---

Expand Down Expand Up @@ -51,11 +67,15 @@ one deployment environment but not on others. 🤷
region: eu-central-1
```

2. Place this file at `~/.config/outtasync.yml` *(optional)*
`refreshCommand` overrides `globalRefreshCommand` whereever set.

*Note: The `globalRefreshCommand` and `refreshCommand` settings are only needed
if you want to invoke the command that refreshes your AWS credentials via the
TUI directly.*

3. Install `outtasync` by running `go install github.com/dhth/outtasync@latest`
2. Place this file at `~/.config/outtasync.yml` *(optional)*

4. Run the TUI as follows:
3. Run the TUI as follows:

```bash
outtasync
Expand All @@ -65,7 +85,7 @@ outtasync --config-file /path/to/config.yml
outtasync -c /path/to/config.yml
```

5. Press `?` to view keyboard shortcuts to use the TUI.
4. Press `?` to view keyboard shortcuts to use the TUI.

Acknowledgements
---
Expand Down

0 comments on commit 9dff56d

Please sign in to comment.