docs: add Swift module docs

starship · May 26, 2020 · 8a5a379 · 8a5a379
1 parent 8136383
commit 8a5a379
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 0 deletions.
diff --git a/docs/config/README.md b/docs/config/README.md
@@ -1274,6 +1274,31 @@ and `$SINGULARITY_NAME` is set.
 symbol = "📦 "
 ```
 
+## Swift
+
+The `swift` module shows the currently installed version of Swift.
+The module will be shown if any of the following conditions are met:
+
+- The current directory contains a `Package.swift` file
+- The current directory contains a file with the `.swift` extension
+
+### Options
+
+| Variable   | Default      | Description                                            |
+| ---------- | ------------ | ------------------------------------------------------ |
+| `symbol`   | `"S "`      | The symbol used before displaying the version of Swift. |
+| `style`    | `"bold 202"` | The style for the module.                              |
+| `disabled` | `false`      | Disables the `swift` module.                            |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[swift]
+symbol = "🐦 "
+```
+
 ## Terraform
 
 The `terraform` module shows the currently selected terraform workspace and version.

diff --git a/docs/presets/README.md b/docs/presets/README.md
@@ -78,4 +78,7 @@ symbol = " "
 
 [rust]
 symbol = " "
+
+[swift]
+symbol = "ﯣ "
 ```