yutakobayashidev / genbaneko

On-site cat on the console!

Genbaneko

Let's display "Yoshi!" on the console. When the code just won't work, when debugging is too tedious, this makes everything better! (It won't).

*Do not use it in a serious place. This "Yoshi!" may be a flag that something bad is about to happen!

　　　　　　　　　 ∧　　/ヽ
　　　　　　　　　/／￣￣＼|
　　　　　　　　 ∠＿＿╋＿＿〉
　　　　　　　　/　  ①八①　＼
　　　　　　　 工ﾆ f(_人_) ｴ |′
　　　　　　　　＼   ヽノ  ノ ヘ
　　　　　　⊂⌒)_＞―――イ (＿) /
　　　　　　　`ー､_ノ/￣ヽ　｜/
　　　　　　　　 ＿|｜　 |　｜
　　　　　　　　(　 人＿ノ　Λ
　　　　　　　　 ＼ス￣￣ﾚ-Λ ＼
　　　　　　　　(￣　)　/ /　＼ﾉ＼
　　　　　　　　 ￣￣　(　ヽ　 ＼_)
　　　　　　　　　　　　＼ノ

Prerequisites

This project requires NodeJS (version 14 or later) and NPM. Node and NPM are really easy to install. To make sure you have them available on your machine, try running the following command.

$ npm -v && node -v
8.11.0
v16.16.0

Table of contents

• Genbaneko
  • Prerequisites
  • Table of contents
  • Getting Started
  • Installation
  • Usage
  • Contributing
  • ToDo
  • Credits
  • Authors
  • License

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Installation

BEFORE YOU INSTALL: please read the prerequisites

To install and set up the library, run:

$ npm install genbaneko

Or if you prefer using Yarn:

$ yarn add genbaneko

Usage

import { genbaneko, mGenbaneko } from 'genbaneko';
// or
const { genbaneko, mGenbaneko } = require('genbaneko');

// Only on-site cats are output
genbaneko();
mGenbaneko.normal();

// Use this when you want your cat to speak or think
mGenbaneko.think('Hello');
mGenbaneko.say('WTF');

// It works without any text arguments.
// In that case, "Yoshi !!" is displayed by default.
mGenbaneko.think();
mGenbaneko.say();

Take advantage of the command line

$ genbaneko help # or, -h, --help
Usage: genbaneko [options] [command]

Let's display "Yoshi!" on the console.

Options:
  -V, --version   output the version number
  -h, --help      display help for command

Commands:
  say [string]    say something
  think [string]  think something
  help [command]  display help for command

"Yoshi !!" is a Japanese word for "challenging during confirmation work". It is used in Japan as a net meme when bad things happen. If the code for your project doesn't work, write a comment saying "なんだか知らんがとにかくよし! "

That's all there is to it. Pull requests to add other kinds of "genbaneko" are welcome! See ToDo for features we would like to add.

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Add your changes: git add .
4. Commit your changes: git commit -am 'Add some feature'
5. Push to the branch: git push origin my-new-feature
6. Submit a pull request 😎

ToDo

• Addition of "doushite"
• Make the character speak
• Colorful cats

Contact us

• Twitter:moons_sub

• Discord:moons#7204

Credits

I wrote README.md with reference to this

Authors

moons14 - moons-14

License

MIT License © 2022 moons14