Skip to content

Commit aebdb9c

Browse files
authored
docs: add warning to README (#23)
1 parent 4fd3781 commit aebdb9c

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,12 @@
11
# Better Git Prompt String
2+
3+
> [!WARNING]\
4+
> 03/16/2024: bgps is actively undergoing a major v2 rewrite in ![go](https://img.shields.io/badge/Go-00ADD8?style=flat-square&logo=go&logoColor=white)
5+
>
6+
> This is a breaking change that will simplify and improve maintainability of bgps
7+
>
8+
> If you prefer to keep using legacy bgps, then use the tag [v1.0.0](https://github.com/mikesmithgh/bgps/releases/tag/v1.0.0)
9+
210
A better bash prompt for git. bgps provides a convenient way to customize
311
the PS1 prompt and to determine information about the current git branch.
412
bgps can indicate if the branch has a clean or dirty working tree, whether

0 commit comments

Comments
 (0)