chore(doc): update readme

- Add examples - Add screenshot
pbnj · Mar 20, 2017 · ae88b34 · ae88b34
1 parent 48bc56f
commit ae88b34
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@
 - Interactive user prompt
 - Account search autocompletion
 - Generates & opens AWS Console URL in default browser
-- Generates script for users to source in their current terminal session
+- Generates script for users to source in their current terminal session (supported platforms: Windows, Linux, Darwin)
 
 ## Install
 
@@ -47,6 +47,21 @@ npm i -g assumer-cli
     $ assumer -a 111111111111 -r target/role -A 123456789012 -R control/role
 ```
 
+### Examples
+- If you know the account numbers and role names you wish to assume:
+  ```
+  $ assumer -a <target-account> -r <target-role> -A <control-account> -R <control-role>
+  ```
+- If you don't know the account numbers and role names:
+  ```
+  $ assumer
+  ```
+- To check if there is a new version of `assumer-cli`:
+  ```
+  $ assumer --check
+  ```
+  ![check version](img/assumer-check.png)
+
 ## Configuration
 
 If you want to use the CLI in interactive mode, `assumer` expects a config file called `.assumer.json` in your home directory.

diff --git a/img/assumer-check.png b/img/assumer-check.png