Skip to content

Commit 553c4ec

Browse files
committed
update readme
1 parent eeab9d2 commit 553c4ec

File tree

1 file changed

+56
-1
lines changed

1 file changed

+56
-1
lines changed

README.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,65 @@ $ pip install aws_coco
3737

3838
## Usage
3939

40+
This section explains how to use `coco` and covers some of the options available to you.
41+
42+
### Basic Usage
43+
4044
```bash
41-
$ coco
45+
$ coco --color green --icon fingerprint --name test
4246
```
4347

48+
This will open the url in a `green` firefox container tab named `test` with a `fingerprint` icon.
49+
50+
### Credential Resolution
51+
52+
This project uses [boto3](https://github.com/boto/boto3). You can learn more about how `boto3` resolves credentials [here](https://boto3.amazonaws.com/v1/documentation/api/1.9.42/guide/configuration.html#configuring-credentials).
53+
54+
If you specify the `--profile` flag, `coco` will pass that value into the `boto3` session and it will attempt to use the corresponding section in the `~/.aws/credentials` file for the session.
55+
56+
### Options
57+
58+
This section contains a description of the various options available to you. You can also pass the `-h` flag to print the help.
59+
60+
|Flag|Description|Default|Required|
61+
|----|-----------|-------|--------|
62+
|`--color`, `-c`|The container tab's color||false|
63+
|`--container`, `--no-container`|Determines if the url should be opened in a firefox container||true|
64+
|`--destination`, `-d`|The destination URL to open in the AWS console||false|
65+
|`--icon`, `-i`|The container tab's icon||false|
66+
|`--name`, `-n`|The container tab's name|The profile name if passed|false|
67+
|`--open`, `--no-open`|Determines if the url should be automatically opened in the browser||true|
68+
|`--profile`, `-p`|The AWS profile to use||false|
69+
70+
### Available Colors
71+
|value|
72+
|-----|
73+
|blue|
74+
|turquoise|
75+
|green|
76+
|yellow|
77+
|orange|
78+
|red|
79+
|pink|
80+
|purple|
81+
82+
### Available Icons
83+
|value|
84+
|-----|
85+
|fingerprint|
86+
|briefcase|
87+
|dollar|
88+
|cart|
89+
|vacation|
90+
|gift|
91+
|food|
92+
|fruit|
93+
|pet|
94+
|tree|
95+
|chill|
96+
|circle|
97+
|fence|
98+
4499
## Development
45100

46101
```bash

0 commit comments

Comments
 (0)