today-idiom/README.md

A Node.js package that picks an English idiom for today

# today-idiom

:pushpin: A Node.js package that picks an English idiom for today

## Table of Contents

- [Installation](#installation)
- [Methods](#methods)
- [Examples](#examples)
- [Author](#author)
- [License](#license)

## Installation

Using npm:

```bash
$ npm install today-idiom
```

Using yarn:

```bash
$ yarn add today-idiom
```

## Methods

### getIdiom()

## Examples

### Import the package

#### NodeJS

```js
const todayIdiom = require('today-idiom');
```

#### ES6/ TypeScript

```js
import todayIdiom from 'today-idiom';
```

### How to use

```js
(async () => {
  try {
    const idiom = await todayIdiom.getIdiom();

    console.log(idiom);
    /* {
      idiom: 'a war of words',
      meaning: "If you're in a war of words with someone, you're having a long argument or dispute with them.",
      examples: [
        'The leaders of the two main political parties are in a war of words over the issue of gun ownership. They debate the topic whenever they see each other.',
        'The war of words between community leaders and church leaders has been dominating the newspaper headlines lately.'
      ]
    } */
  } catch (error) {
    console.log(error);
  }
})();
```

## Author

[Tien-Dzung Nguyen (KutieKat)](https://github.com/KutieKat)

## License

[MIT](LICENSE)