Skip to content

Commit 2d3f346

Browse files
committed
Docs
1 parent 9251f95 commit 2d3f346

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

readme.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,20 @@ $panel->plugins([
9191
]);
9292
```
9393

94+
### Git Branch
95+
96+
You can enable the display of the current git branch in the badge via `->showGitBranch()`. This requires the `exec()` function to be enabled in your PHP configuration.
97+
98+
```php
99+
use pxlrbt\FilamentEnvironmentIndicator\EnvironmentIndicatorPlugin;
100+
use Filament\Support\Colors\Color;
101+
102+
$panel->plugins([
103+
EnvironmentIndicatorPlugin::make()
104+
->showGitBranch()
105+
]);
106+
```
107+
94108
## Contributing
95109

96110
If you want to contribute to this packages, you may want to test it in a real Filament project:

0 commit comments

Comments
 (0)