README.md in aws_assume_role-0.1.1 vs README.md in aws_assume_role-0.1.2
- old
+ new
@@ -1,7 +1,12 @@
aws-assume-role
---------------
+[](https://travis-ci.org/scalefactory/aws-assume-role)
+[](https://coveralls.io/github/scalefactory/aws-assume-role?branch=master)
+[](https://codeclimate.com/github/scalefactory/aws-assume-role)
+[](https://libraries.io/rubygems/aws_assume_role)
+[](https://badge.fury.io/rb/aws_assume_role)
aws-assume-role is a utility intended for developer and operator environments
who need to use 2FA and role assumption to access AWS services.
aws-assume-role can store both AWS access keys and ephemeral session tokens in
@@ -15,15 +20,15 @@
This helps prevent credential leaking and theft, and means they aren't stored on
disk as unencrypted files.
It allows easy credential management and role assumption with a 2FA/MFA device.
-For more information on role assumption, see the AWS documentation.
+For more information on role assumption, see the [AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html).
Requirements
------------
-* Ruby ≥ 2.2
+* Ruby ≥ 2.1
* OS X KeyChain or GNOME Keyring
Install
-------
@@ -177,17 +182,17 @@
* `region`
`aws_assume_role` resolves credentials in almost the same way as the AWS SDK, i.e.:
```no-highlight
-static credentials ⟶ environment variables ⟶ configured profiles
+static credentials ⟶ environment variables ⟶ configured profiles role ⟶ assumption (look up source profile and check for 2FA)
```
Any of the above may get chained to do MFA or role assumption, or both,
in the following order:
```no-highlight
-second factor ⟶ role assumption (look up source profile and check for 2FA) ⟶ ecs/instance profile
+second factor ⟶ ecs/instance profile
```
These are the same as the AWS SDK equivalents whereever possible. The command line help will give an explanation of the rest.
### Monkeypatching the AWS SDK