readme.md

My Zodiac Sign Is

Discover the zodiac sign and know what their information, such as elements and behavioral characteristics.

♈ ♉ ♊ ♋ ♌ ♍ ♎ ♏ ♐ ♑ ♒ ♓

Install

$ yarn add mzsi

Usage

import mzsi from 'mzsi';

const day = 22
    , month = 8;
    
const sign = mzsi(month, day);

console.log(sign.name); // Leo
console.log(sign.symbol); // ♌
console.log(sign.about.element); // Fire
console.log(sign.about.keywords.strength); // ["confident", "ambitious", "generous", "loyal", "encouraging"]
console.log(sign.about.keywords.weakness); // ["pretentious", "domineering", "melodramatic", "stubborn", "vain"]

API

mzsi(month, day, language)

Returns an object with:

• name (string) - The name of sign.
• symbol (unicode char) - The representative symbol.
• about (object) - The informations of element and characteristics.

Currently, the mzsi has translate with two languages (pt-br, en-us). You can choose via language parameter.

Related

• mzsi-cli - CLI for this module.

License

MIT © Cauê Alves