Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
sam701 committed Jan 19, 2020
1 parent d874eb7 commit 5fcfffe
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,16 @@ In a new shell you can call `assume <profile name>` to assume the role from `<pr

## Features

### Shows assumed profile in shell prompt
![prompt](./doc/prompt.png)

### Explains what has been done
### Simple installation
It is just a single [binary](https://github.com/sam701/awscredx/releases/latest) that creates all required helper shell scripts.
It explains what has been done.
![init](./doc/init.png)

### Shows assumed profile with "expires in" in shell prompt
![prompt](./doc/prompt.png)

### Configurable role profiles
The [configuration file](./src/init/config-template.toml) is well documented.
Well documented [configuration file](./src/init/config-template.toml).
```toml
[profiles]
dev = "arn:aws:iam::123456589012:role/Admin"
Expand All @@ -34,6 +36,9 @@ prod = "arn:aws:iam::123456589013:role/TestRole"
The MFA is read from your Yubikey so you do not need to type it.\
![prompt](./doc/yubikey.png)

### Lists current credentials with their expiration times
![prompt](./doc/credential-list.png)

### Checks for new versions
![version-check](./doc/version-check.png)

Expand Down
Binary file added doc/credential-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/prompt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5fcfffe

Please sign in to comment.