diff --git a/README.md b/README.md index 81172ac..94d25df 100644 --- a/README.md +++ b/README.md @@ -54,7 +54,7 @@ code (such as `{5}` or `{65}`). #### `LocalClient` `LocalClient` provides a client interface for interacting with a Vestaboard -over the local network using [Vestaboard's Local API](https://docs.vestaboard.com/local). +over the local network using [Vestaboard's Local API](https://docs.vestaboard.com/docs/local-api/introduction). Note that Vestaboard owners must first request a [Local API enablement token](https://www.vestaboard.com/local-api) @@ -80,7 +80,7 @@ assert local_client.read_message() == message #### `ReadWriteClient` `ReadWriteClient` provides a client interface for interacting with a Vestaboard -using the [Read / Write API](https://docs.vestaboard.com/read-write). +using the [Read / Write API](https://docs.vestaboard.com/docs/read-write-api/introduction). Note that Vestaboard owners must first obtain their Read / Write API key by enabling the Vestaboard's Read / Write API via the Settings section of the @@ -99,8 +99,8 @@ assert rw_client.read_message() == message ### Character Encoding All Vestaboard characters (letters, numbers, symbols, and colors) are encoded -as integer [character codes](https://docs.vestaboard.com/characters). Vesta -includes some useful routines for working with these character codes. +as integer [character codes](https://docs.vestaboard.com/docs/characterCodes). +Vesta includes some useful routines for working with these character codes. `encode()` encodes a string as a list of character codes. In addition to printable characters, the string can contain character code sequences inside diff --git a/docs/index.rst b/docs/index.rst index 46333df..24f43e0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -32,7 +32,7 @@ API Clients :py:class:`vesta.LocalClient` provides a client interface for interacting with a Vestaboard over the local network using `Vestaboard's Local API -`_. +`_. .. important:: @@ -46,7 +46,8 @@ a Vestaboard over the local network using `Vestaboard's Local API ------------------- :py:class:`vesta.ReadWriteClient` provides a client interface for interacting -with a Vestaboard using the `Read / Write API `_. +with a Vestaboard using the `Read / Write API +`_. .. important:: @@ -61,8 +62,8 @@ Character Encoding ================== All Vestaboard characters (letters, numbers, symbols, and colors) are encoded -as integer `character codes `_. Vesta -includes some helpful routines for working with these character codes. +as integer `character codes `_. +Vesta includes some helpful routines for working with these character codes. .. automodule:: vesta.chars :members: COLS, ROWS, Row, Rows