https://github.com/kkeeth/ja-greetings

https://github.com/kkeeth/ja-greetings

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/kkeeth/ja-greetings
• Owner: kkeeth
• License: mit
• Created: 2017-01-04T15:01:53.000Z (almost 8 years ago)
• Default Branch: main
• Last Pushed: 2024-10-27T15:36:25.000Z (about 2 months ago)
• Last Synced: 2024-11-01T11:42:37.525Z (about 2 months ago)
• Language: JavaScript
• Size: 444 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

[![npm version](https://badge.fury.io/js/ja-greetings.svg)](https://badge.fury.io/js/ja-greetings)

[![Build Status](https://travis-ci.org/k-kuwahara/ja-greetings.svg?branch=master)](https://travis-ci.org/k-kuwahara/ja-greetings)

[![Code Climate](https://codeclimate.com/github/kkeeth/ja-greetings/badges/gpa.svg)](https://codeclimate.com/github/kkeeth/ja-greetings)

![node](https://img.shields.io/badge/node-%3E%3D%208.0.0-brightgreen.svg?style=social)

[![MIT License](http://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE)

# ja-greetings

```bash

_______________

            あ

      今  おけ

    よ年  めま

    ろも  でし

    し    とて

  おく    う

  願      ご

  い      ざ

  し      い

  ま      ま

  す      す

  。      。

---------------

```

`ja-greetings` is a cli tool that displays the greetings of each season in Japan.

## Install

```bash

$ npm i ja-greetings -g

```

※The corresponding version of nodejs is version 6 or higher!

## Usage

Just run the command! (the following is an example)

```bash

$ ja-greetings new

# shortcut

$ jgr new

```

__Commands:__

```bash

  a, all    : show all greetings

  n, new    : new years greeting

  s, summer : summer greeting

  w, winter : winter greeting

  l, last   : end of years greeting

  t, thx    : thanks greeting

  so, sorry : sorry  greeting

```

__Optios:__

```bash

  -d, --dialect   Greeting from each prefecture dialect

  -s, --surround  Decoration of the surround

  -l, --language  Select language

  -v, --version   Show version

  -h, --help      Show help

```

__Dialects:__

```bash

kyoto, osaka, okinawa, hiroshima

```

__Languages__

```bash

en, ch

```

__Surrounds:__

```bash

no        Do not surround text

w-star    ☆

b-star    ★

asterisk  ＊

w-tri     top: ▽  , bottom: △

b-tri     top: ▼  , bottom: ▲

slash     top: /￣, bottom: ＿/

```

## Test

```bash

$ chmod +x cli.js

$ npm t

```

## License

[MIT](https://github.com/kkeeth/ja-greetings/blob/master/LICENSE)

## Others

I'm waiting for you at any time, including code reviews, bug reports, feature additions, questions and more!