# wordlib 📚

[![Test](https://github.com/arvidbt/wordlib/actions/workflows/test.yml/badge.svg)](https://github.com/arvidbt/wordlib/actions/workflows/test.yml/badge.svg)
![GitHub](https://img.shields.io/github/license/arvidbt/wordlib)
![GitHub package.json version (subfolder of monorepo)](https://img.shields.io/github/package-json/v/arvidbt/wordlib)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/arvidbt/wordlib)

Small package for playing around with different languages.

## Installation 📦

To use the package, first install it:

```bash
npm i @arvidbt/wordlib
```

Then, import it as:

```javascript
import { WordLib } from "@arvidbt/wordlib";

// There are dictionaries available via NPM, such as:
import { english_words } from "@arvidbt/english-words";
import { swedish_words } from "@arvidbt/swedish-words";
```

Instantiate the class:

```javascript
// For English,

const enWords = new WordLib(english_words);
// For Swedish,
const svWords = new WordLib(swedish_words);
// For custom dictionary,
const customWords = new WordLib({ customDictionary: ["custom", "dictionary"] });
```

Now, you're ready to use wordlib for your own applications 🚀.

## Usage 📖

For documentation and all the features WordLib brings, visit [the official documentation](https://arvidbt.github.io/wordlib/).

The functions can be used in conjunction with eachother, such as:

```javascript
const words = new WordLib(YOUR_DICTIONARY_HERE);
const randomPalindrome = words.random({
  customDictionary: words.palindromes(),
});
```