Skip to content

Commit

Permalink
Move "Messages" text under Subscription API
Browse files Browse the repository at this point in the history
This text was only meant to apply to the Subscription API. The other
APIs only work in terms of character arrays.
  • Loading branch information
jparise committed Apr 9, 2024
1 parent 6edb9ca commit 2aedd00
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ Note that an API secret and key is required to get subscriptions or send
messages. These credentials can be created from the [Developer section of the
web app](https://web.vestaboard.com/).

Messages can be posted as either text strings or two-dimensional arrays of
character codes representing the exact positions of characters on the board.

If text is specified, the lines will be centered horizontally and vertically.
Character codes will be inferred for alphanumeric and punctuation characters,
or they can be explicitly specified using curly braces containing the character
code (such as `{5}` or `{65}`).

```py
import vesta
subscription_client = vesta.SubscriptionClient("api_key", "api_secret")
Expand Down Expand Up @@ -115,16 +123,6 @@ superseded by the other APIs listed above. In particular, Vestaboard encourages
users of the Platform API to switch to the [Subscription API](#subscription-api),
which offers nearly identical functionality.

### Messages

Messages can be posted as either text strings or two-dimensional arrays of
character codes representing the exact positions of characters on the board.

If text is specified, the lines will be centered horizontally and vertically.
Character codes will be inferred for alphanumeric and punctuation characters,
or they can be explicitly specified using curly braces containing the character
code (such as `{5}` or `{65}`).

### Character Encoding

All Vestaboard characters (letters, numbers, symbols, and colors) are encoded
Expand Down

0 comments on commit 2aedd00

Please sign in to comment.