Skip to content

Commit ec98527

Browse files
authored
docs: prepare for v0.3.0 release (#41)
1 parent db5e209 commit ec98527

3 files changed

Lines changed: 24 additions & 24 deletions

File tree

.github/workflows/main.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ on:
1212
jobs:
1313
build:
1414
name: Build
15-
runs-on: ubuntu-latest
15+
runs-on: ubuntu-22.04
1616

1717
steps:
1818
- name: Checkout code
@@ -21,7 +21,7 @@ jobs:
2121
- name: Setup go
2222
uses: actions/setup-go@v2
2323
with:
24-
go-version: 1.18
24+
go-version: 1.19
2525

2626
- name: Build binary
2727
run: |-

.github/workflows/release.yml

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
jobs:
1010
build:
1111
name: Release
12-
runs-on: ubuntu-latest
12+
runs-on: ubuntu-22.04
1313

1414
steps:
1515
- name: Checkout code
@@ -18,15 +18,7 @@ jobs:
1818
- name: Setup go
1919
uses: actions/setup-go@v2
2020
with:
21-
go-version: 1.18
22-
23-
- name: Setup upx
24-
run: |-
25-
cd "$(mktemp -d)"
26-
wget -q https://github.com/upx/upx/releases/download/v3.96/upx-3.96-amd64_linux.tar.xz
27-
tar -xf upx-3.96-amd64_linux.tar.xz
28-
sudo install upx-3.96-amd64_linux/upx /usr/bin/upx
29-
rm -rf "$PWD"
21+
go-version: 1.19
3022

3123
- name: Build and publish release artifacts
3224
uses: goreleaser/goreleaser-action@v2

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![AWS Console][banner-image-link]][github-repo-link]
2+
13
[![License][license-badge]][license-link]
24
[![Actions][github-actions-badge]][github-actions-link]
35
[![Releases][github-release-badge]][github-release-link]
@@ -12,7 +14,7 @@ Prebuilt binaries for several architectures can be found attached to any of the
1214

1315
For Linux:
1416
```shell
15-
wget https://github.com/joshdk/aws-console/releases/download/v0.2.0/aws-console-linux-amd64.tar.gz
17+
wget https://github.com/joshdk/aws-console/releases/download/v0.3.0/aws-console-linux-amd64.tar.gz
1618
tar -xf aws-console-linux-amd64.tar.gz
1719
sudo install aws-console /usr/bin/aws-console
1820
```
@@ -55,75 +57,81 @@ This tool will detect and automatically federate IAM users transparently.
5557

5658
Generate an AWS Console login URL for the default profile:
5759
```shell
58-
aws-console
60+
$ aws-console
5961
```
6062

6163
Or for the named "production" profile:
6264
```shell
63-
aws-console production
65+
$ aws-console production
6466
```
6567

6668
Or from the output of the aws cli itself:
6769
```shell
68-
aws sts assume-role … | aws-console -
70+
$ aws sts assume-role … | aws-console -
6971
```
7072

7173
---
7274

7375
Open the generated URL using the default browser:
7476
```shell
75-
aws-console --browser
77+
$ aws-console --browser
7678
```
7779

7880
Or copy the URL to the system clipboard:
7981
```shell
80-
aws-console --clipboard
82+
$ aws-console --clipboard
8183
```
8284

8385
---
8486

8587
Display the generated URL in the terminal as a QR code:
8688
```shell
87-
aws-console --qr
89+
$ aws-console --qr
8890
```
8991

9092
Or save it as an image to a file:
9193
```shell
92-
aws-console --qr > qr.png
94+
$ aws-console --qr > qr.png
9395
```
9496

9597
---
9698

9799
Limit session duration to half an hour:
98100
```shell
99-
aws-console --duration 30m
101+
$ aws-console --duration 30m
100102
```
101103

102104
Redirect to the IAM service after logging in:
103105
```shell
104-
aws-console --location iam
106+
$ aws-console --location iam
105107
```
106108

107109
---
108110

109111
Federate the user and use the name "audit":
110112
```shell
111-
aws-console --name audit
113+
$ aws-console --name audit
112114
```
113115

114116
Attach a readonly policy to the federated user:
115117
```shell
116-
aws-console --policy readonly
118+
$ aws-console --policy readonly
117119
```
118120

119121
## License
120122

121123
This code is distributed under the [MIT License][license-link], see [LICENSE.txt][license-file] for more information.
122124

125+
<p align="center">
126+
Created by <a href="https://github.com/joshdk">Josh Komoroske</a> ☕
127+
</p>
128+
129+
[banner-image-link]: https://user-images.githubusercontent.com/307183/192825989-367a0b2b-7fe1-4dae-81ef-f4459c061034.png
123130
[github-actions-badge]: https://github.com/joshdk/aws-console/workflows/Build/badge.svg
124131
[github-actions-link]: https://github.com/joshdk/aws-console/actions
125132
[github-release-badge]: https://img.shields.io/github/release/joshdk/aws-console/all.svg
126133
[github-release-link]: https://github.com/joshdk/aws-console/releases
134+
[github-repo-link]: https://github.com/joshdk/aws-console
127135
[license-badge]: https://img.shields.io/badge/license-MIT-green.svg
128136
[license-file]: https://github.com/joshdk/aws-console/blob/master/LICENSE.txt
129137
[license-link]: https://opensource.org/licenses/MIT

0 commit comments

Comments
 (0)