Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moons-14/genbaneko
On-site cat on the console!
https://github.com/moons-14/genbaneko
cats console console-log genbaneko log nodejs npm npm-package yoshi
Last synced: about 2 months ago
JSON representation
On-site cat on the console!
- Host: GitHub
- URL: https://github.com/moons-14/genbaneko
- Owner: moons-14
- License: mit
- Created: 2022-08-08T12:53:35.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-22T11:16:55.000Z (10 months ago)
- Last Synced: 2024-11-03T03:20:12.917Z (3 months ago)
- Topics: cats, console, console-log, genbaneko, log, nodejs, npm, npm-package, yoshi
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/genbaneko
- Size: 1.94 MB
- Stars: 20
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/moons-14/genbaneko/actions/workflows/release.yml)
[](https://badge.fury.io/js/genbaneko)
[](https://github.com/prettier/prettier)
# 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](http://nodejs.org/) and [NPM](https://npmjs.org/) are really easy to install.
To make sure you have them available on your machine,
try running the following command.
```sh
$ npm -v && node -v
8.11.0
v16.16.0
```
## Table of contents
- [Genbaneko](#Genbaneko)
- [Prerequisites](#prerequisites)
- [Table of contents](#table-of-contents)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [ToDo](#ToDo)
- [Credits](#credits)
- [Authors](#authors)
- [License](#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](#prerequisites)
To install and set up the library, run:
```sh
$ npm install genbaneko
```
Or if you prefer using Yarn:
```sh
$ yarn add genbaneko
```
## Usage
```javascript
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](#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 :sunglasses:
## ToDo
- Addition of "doushite"
- Make the character speak
- Colorful cats
## Contact us
- Twitter:[moons_sub](https://twitter.com/moons_sub)
- Discord:moons#7204
## Credits
I wrote README.md with reference to [this](https://gist.github.com/andreasonny83/7670f4b39fe237d52636df3dec49cf3a#building-a-distribution-version)
## Authors
**moons14** - [moons-14](https://github.com/moons-14)
## License
[MIT License](https://andreasonny.mit-license.org/2022) © 2022 moons14