Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/robertmarsal/lolcatjs

For the lols
https://github.com/robertmarsal/lolcatjs

lol

Last synced: 3 months ago
JSON representation

For the lols

Lists

README

        

![lolcatjs](/assets/banner.png)

> For when you need the lols but don't have the rubies.

This is a node port of the famous [lolcat](https://github.com/busyloop/lolcat) gem. It implements all the original functionality and behaviour.

## Installation
```javascript
npm install -g lolcatjs
```

## Usage

**Command Line**
```javascript
lolcatjs [OPTION]... [FILE]...

Concatenate FILE(s), or standard input, to standard output.
With no FILE, or when FILE is -, read standard input.

--spread, -p : Rainbow spread (default: 8.0)
--freq, -F : Rainbow frequency (default: 0.3)
--seed, -S : Rainbow seed, 0 = random (default: 0)
--animate, -a: Enable psychedelics
--duration, -d : Animation duration (default: 12)
--speed, -s : Animation speed (default: 20.0)
--force, -f: Force color even when stdout is not a tty
--version, -v: Print version and exit
--help, -h: Show this message

Examples:
lolcatjs f - g Output f's contents, then stdin, then, g's contents.
lolcatjs Copy standard input to standard output.
fortune | lolcatjs Display a rainbow cookie.
```

**NPM Module**
```javascript
const lolcatjs = require('lolcatjs');

lolcatjs.options.seed = Math.round(Math.random() * 1000);
lolcatjs.options.colors = true;

lolcatjs.fromString('I can has Cheezburger?');
```

## Demo
![lolcatjs](/assets/demo.gif)

## Thanks
Nur Ortega Marsal for creating the banner

## License
WTFPL © Robert Marsal