diff options
| author | Ryan Sabatini <11415980+rjsab@users.noreply.github.com> | 2022-11-27 08:02:23 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-27 15:02:23 +0100 |
| commit | 6e15c00238a06e92cf411a669590002eb22324e7 (patch) | |
| tree | 329abf66b8882adc5e721f906f165e13bdfd2681 /docs/config/README.md | |
| parent | 5cfa397ef9fe720bad85fe23275ef55e4a342817 (diff) | |
feat(azure): add username to azure module config (#4323)
* add username to azure module config
* add username to azure module config
* formatting with cargo fmt
* Handle parse failure on azureProfile.json
allow program to procede if unable to parse azure profile due to missing
keys from the JSON structure.
remove unused keys from struct
Code cleanup with suggestions from PR maintainer
Cargo clippy fixes
Diffstat (limited to 'docs/config/README.md')
| -rw-r--r-- | docs/config/README.md | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index de60a2b56..0715a4c27 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -439,7 +439,7 @@ Enterprise_Naming_Scheme-voidstars = 'void**' ## Azure -The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file. +The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription or the username, as defined in the `~/.azure/azureProfile.json` file. ### Options @@ -450,7 +450,9 @@ The `azure` module shows the current Azure Subscription. This is based on showin | `style` | `'blue bold'` | The style used in the format. | | `disabled` | `true` | Disables the `azure` module. | -### Example +### Examples + +#### Display Subscription Name ```toml # ~/.config/starship.toml @@ -462,6 +464,18 @@ symbol = 'ﴃ ' style = 'blue bold' ``` +#### Display Username + +```toml +# ~/.config/starship.toml + +[azure] +disabled = false +format = "on [$symbol($username)]($style) " +symbol = "ﴃ " +style = "blue bold" +``` + ## Battery The `battery` module shows how charged the device's battery is and its current charging status. |