Skip to content

mjljr/vestalia

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vestalia

Build Status codecov Crates.io Documentation

This crate is an async wrapper for the Vestaboard API. It is a third-party developed crate and has no relation to Vestaboard, Inc.

Features

  • Supports Vestaboard API key pairs and auto-configuration of the subscription id
  • Validation of text and vector character inputs
  • Utilities such as converting text lines into vectors to support Vestaboard character mapping

Usage

Add this to your Cargo.toml:

[dependencies]
vestalia = "0.1.1"

Then:

use vestalia::Vestaboard;

let client = Vestaboard::new(api_key, api_secret);
let response = client.text("Hello world!").await;
// If you'd like to handle API errors... Do something like this
match response {
    Ok(post) => println!("{:#?}", post),
    Err(error) => panic!("{}", error),
}

License

Licensed under the MIT license:

Contribution

If you are interested in contributing, feel free to send a PR! This is my first foray into rust lang so always open to feedback and suggestions. If you have any problems please feel free to open an issue as well.

While I can do what I can to help, I do not have control over the Vestaboard API itself, so feature requests and support will be limited to what the official API can support.

About

A Vestaboard API wrapper for Rust

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages