1
0
Fork 0

Update README.md - rephrasing/formatting

master
stweedo 2023-06-18 20:00:50 -05:00 committed by GitHub
parent abce2fadc5
commit 8d27267a95
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 2 deletions

View File

@ -14,10 +14,12 @@ After you've found the perfect position for your boxes, you can save their posit
__JSON Configuration:__
Each box can be customized extensively via a simple JSON configuration. You can also add a custom text string to your configuration with the "string" attribute. Here's what an example configuration might look like:
Each box can be customized extensively via a simple JSON configuration. You can add a custom text string to your configuration with the "string" parameter and you can match system theme colors by using "fg", "bg", "fg2", "bg2", "fgH", or "bgH" for any of the color parameters.
## Config File Structure
Here's what an example configuration might look like:
```
{
"customBox": { //
@ -39,6 +41,7 @@ Each box can be customized extensively via a simple JSON configuration. You can
}
}
```
__Breakdown of Parameters:__
* **string:** The text string to be displayed inside the box.
@ -48,7 +51,7 @@ Each box can be customized extensively via a simple JSON configuration. You can
* **outline:** The thickness of the outline around the text.
* **color:** The color of the text. Match current system theme colors with: ("fg", "bg", "fg2", "bg2", "fgH", "bgH").
* **color:** The color of the text.
* **outlineColor:** The color of the text outline.