diff --git a/.github/workflows/go.yml b/.github/workflows/build.yml
similarity index 67%
rename from .github/workflows/go.yml
rename to .github/workflows/build.yml
index f35f263..c50ceeb 100644
--- a/.github/workflows/go.yml
+++ b/.github/workflows/build.yml
@@ -1,7 +1,4 @@
-# This workflow will build a golang project
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
-
-name: Go
+name: build
on:
push:
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index f5c63fe..3b5b513 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,4 +1,4 @@
-name: goreleaser
+name: release
on:
pull_request:
diff --git a/README.md b/README.md
index 707c7e2..b03d6ca 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,8 @@
AWS Multi-Factor Authentication manager
-
-
+
+
@@ -21,21 +21,27 @@
+
## Installation
-
+
#### Install script (Linux & macOS)
+
Download the appropriate binary from the releases page, `chmod +x`, and drop it into your `PATH`.
#### [Chocolatey][4] (Windows)
+
```powershell
choco install mfaws
```
**Note**: Make sure your hardware clock is correct! [Especially if dual booting][7]. If your time is out of sync, your MFA attempts will fail _and_ the codes `oathtool` generates will be wrong (if you use it).
+
+
## Usage
+
```
AWS Multi-Factor Authentication manager
@@ -64,13 +70,17 @@ Flags:
Use "mfaws [command] --help" for more information about a command.
```
+
+
## Examples
#### Using the default profile
+
Make sure you have the following in your `$HOME/.aws/credentials` file:
+
```
[default-long-term]
aws_access_key_id = $YOUR_AWS_ACCESS_KEY_ID
@@ -79,13 +89,17 @@ aws_mfa_device = $YOUR_MFA_DEVICE_ARN
```
Then, simply run
+
```sh
mfaws
```
+
to fetch temporary credentials for your **default** AWS profile. More advanced configuration is possible (see [Usage](#usage)).
#### Combine `mfaws` with [`oathtool`][2]
+
Set an alias for generating your MFA token, then pipe it into `mfaws`:
+
```sh
alias otp-aws="oathtool --totp --base32 $YOUR_AWS_TOTP_KEY"
@@ -93,8 +107,8 @@ otp-aws | mfaws
# or
otp-aws | mfaws -p some-profile
```
-
+
[1]: https://github.com/pbar1/mfaws/releases
[2]: https://www.nongnu.org/oath-toolkit/