2023-10-02 05:14:21 +00:00
# phishies
## Node.js aquarium generator module
This module is still in early stages of development, probabilities still need to be tweaked further.
# Getting Started
## Installation
To install for just your project:
```
npm i phishies
```
To install globally:
```
npm i phishies -g
```
## Use in script
```
2023-10-03 04:03:43 +00:00
var phish = require('phishies')
2023-10-02 05:14:21 +00:00
```
# Usage
Currently the only available use is the main aquarium generator, which is invoked by using `phish.aquarium(height, length)` . The output of the aquarium generator is an array with each line as a value
2023-10-02 05:17:49 +00:00
Example `phish.aquarium(5,5)` output:
2023-10-02 05:14:21 +00:00
```
[ '
```
# Credits
This project was inspired entirely by https://botsin.space/@EmojiAquarium, source code found at https://gitlab.com/JoeSondow/fishies
# License
This module is licensed under the ISC license.
