summaryrefslogtreecommitdiffstats
path: root/docs/config/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/config/README.md')
-rw-r--r--docs/config/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index cfc94e484..9b2973235 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -841,6 +841,31 @@ and `poetry` packages.
symbol = "🎁 "
```
+## PHP
+
+The `php` module shows the currently installed version of PHP.
+The module will be shown if any of the following conditions are met:
+
+- The current directory contains a `composer.json` file
+- The current directory contains a `.php` file
+
+### Options
+
+| Variable | Default | Description |
+| ---------- | ------------ | ------------------------------------------------------ |
+| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
+| `style` | `"bold red"` | The style for the module. |
+| `disabled` | `false` | Disables the `php` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[php]
+symbol = "🔹 "
+```
+
## Python
The `python` module shows the currently installed version of Python.