Skip to content

Commit

Permalink
Update README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
ShaneSutro committed Feb 12, 2023
1 parent 338060b commit e8eff06
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -297,9 +297,13 @@ The standard Vestaboard API allows you to post plain text and Vestaboard's endpo
The `Formatter().convertPlainText()` accepts the following:

* `text` - the text to be formatted

* `size` - \[rows, columns] - the size to constrain the text to. Defaults to `[6, 22]`, which is the size of the board

* `justify` - accepts `'center' | 'left' | 'right'`. `'center'` is the default.

* `align` - accepts `'center' | 'top' | 'bottom'`. `'center'` is the default

* `useVestaboardCentering` - `True | False` - Vestaboard's formatting centers the longest line when splitting lines, then left-justifies all remaining lines based on that line.
It's a subtle difference and doesn't apply to every text that's passed in, so you may not notice anything different when using this option. Furthermore, this option *only applies when `justify` is set to `left` or `right`*, since it has no effect on center-justified text.

Expand Down

0 comments on commit e8eff06

Please sign in to comment.