minitron.js
v1.0.0
Published
A dot-matrix display-like javascript plugin.
Downloads
9
Maintainers
achillesrasquinhaReadme
Minitron.js
A dot-matrix display-like javascript plugin.
Table of Contents
Installation
Clone the repository
git clone https://github.com/achillesrasquinha/Minitron.gitInstall using npm
npm install minitron.jsInstall using bower
bower install minitron.jsIn 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
| Return | Method | Description |
| ------------- | ----------------------| -------------------------------------------------------- |
| Minitron | setMessage(message) | Initializes/Updates the message to-be displayed. |
| Minitron | setOptions(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.