From a65871849dfb7485bd8b24d96a4769a057d2e6f3 Mon Sep 17 00:00:00 2001 From: hgw Date: Tue, 3 Oct 2023 05:59:12 +0000 Subject: [PATCH] new readme --- README.md | 43 ++++++++++++++++++++++--------------------- 1 file changed, 22 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index cc12937..7141a57 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,42 @@ # phishies -## Node.js aquarium generator module +โœจ Introducing PHISH: Pinnacle of Harmonized Informational Software for Hydroenvironments! โœจ -This module is still in early stages of development, probabilities still need to be tweaked further. +Step into the vanguard of digital ichthyological representation with PHISH. This isn't merely a rudimentary text-based aquatic display; it's an avant-garde, ENTERPRISE-GRADE solution synthesized for the exigencies of the forthcoming digital epoch. ๐ŸŒŠ + +๐Ÿ“š Quantum Scalability: Whether you are an aficionado or a global conglomerate, PHISH gracefully expands to an astounding 4.2 billion rows, offering a tableau as boundless as the deepest oceanic trenches. ๐ŸŸ + +๐Ÿ” Harmonized for Kubernetes: For connoisseurs of unparalleled efficiency and dependability, PHISH has been meticulously crafted to operate seamlessly within the Kubernetes (k8s) ecosystem. Embrace the zenith of container orchestration and witness your ichthyological wonders prosper in concert! ๐Ÿ  + +๐ŸŒ Endorsed by Luminary Institutions: Our veracity is not standalone. Behemoths such as Amazon and SpaceX, among other global leaders, have already submerged into the profundities of PHISH. Engage with the assurance of aligning with a distinguished consortium of aficionados! ๐Ÿš€ + +๐ŸŽ“ Renaissance Features: From the intricate textual fluid dynamics to the sophisticated stochastic generation of each emoji fish, we've amalgamated countless man-hours into ensuring every granular facet is of the highest echelon. PHISH is not a mere application; it's an intellectual odyssey. ๐ŸŒŒ + +Embark with us, and reconceptualize the boundaries of virtual hydroenvironments. The future of digital ichthyology is here, and it's PHISH! ๐ŸŽ‰ # Getting Started -## Installation +## Installation and Usage -To install for just your project: - -``` -npm i phishies -``` - -To install globally: - -``` -npm i phishies -g -``` - -## Use in script +To install, run `npm i phishies` or `npm i phishies -g` to install globally. ``` var phish = require('phishies') + +//phish.aquarium(height, width) +phish.aquarium(5, 5) //generates a 5x5 aquarium ``` -# 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 - -Example `phish.aquarium(5,5)` output: +`phish.aquarium(h,w)` putputs an array of the following form: ``` [ 'ใ€€ใ€€ใ€€ใ€€ใ€€', 'ใ€€๐Ÿกใ€€ใ€€ใ€€', 'ใ€€ใ€€ใ€€๐Ÿก๐Ÿ ', '๐Ÿ™๐Ÿกใ€€๐Ÿฆ‘ใ€€', 'ใ€€ใ€€๐Ÿฆ€๐ŸŒฟใ€€' ] ``` +# Contributing + +We welcome contributions from the community. To get started, come across to https://git.supernets.org (if you are not already here), and begin making pull requests! + # Credits This project was inspired entirely by https://botsin.space/@EmojiAquarium, source code found at https://gitlab.com/JoeSondow/fishies