1.0.0 • Published 8 years ago

minitron.js v1.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
8 years ago

Minitron.js

A dot-matrix display-like javascript plugin.

demo

Table of Contents

Installation

Clone the repository
git clone https://github.com/achillesrasquinha/Minitron.git
Install using npm
npm install minitron.js
Install using bower
bower install minitron.js

In your HTML file

<!DOCTYPE html>
<html>
  <head>
    ...
  </head>
  <body>
    ...
    <script src="/path/to/minitron.js"></script>
  </body>
</html>

Usage

A template declaration would be as follows

Minitron.make("<your_message>", { /*<your_options>*/ });

Methods

ReturnMethodDescription
MinitronsetMessage(message)Initializes/Updates the message to-be displayed.
MinitronsetOptions(option)Pass your options to settings to change them any time.

Options

Minitron.make("<your_message_string>", {
    color: '#00FFFF' /*default*/ | "<your_hex_string>",
    speed: 50        /*default*/ | /*<your_speed> higher the speed value, slower to render*/
});

License

Code released under the MIT License.