word-puzzle-shuffler/README.md

shuffle given two words properly so user can find out the word into the puzzle

# Word Puzzle Shuffler

[![Build Status](https://travis-ci.com/OzkanAbdullahoglu/word-puzzle-shuffler.svg?branch=master)](https://travis-ci.com/OzkanAbdullahoglu/word-puzzle-shuffler) [![npm version](https://badge.fury.io/js/word-puzzle-shuffler.svg)](https://badge.fury.io/js/word-puzzle-shuffler)
![GitHub repo size](https://img.shields.io/github/repo-size/OzkanAbdullahoglu/word-puzzle-shuffler)
[![Greenkeeper badge](https://badges.greenkeeper.io/OzkanAbdullahoglu/word-puzzle-shuffler.svg)](https://greenkeeper.io/)

A simple package to shuffle given two words properly to the 3 x 3 matrices. 

## Table of Contents
- [Usage](#usage)
- [TODO](#todo)

## Usage

[![npm install word-puzzle-shuffler](https://nodei.co/npm/word-puzzle-shuffler.png)](https://nodei.co/npm/word-puzzle-shuffler/) 

### `const shuffle = require('word-puzzle-shuffler')`
### `const shuffledData = shuffle(['wordA: string, wordB: string])`
### `shuffledData.getCellValues`
getCellValues returns an array which includes shuffled letters from 0 - 9 indexes, 
Total length of the two words have to be 9 to fit in 3 x 3 matrices.

```const shuffledData = shuffle(['LEMON', 'PEAR']);```

```const cellValues = shuffledData.getCellValues;```

```["E","N","O","A","P","M","R","E","L"]```

<p align="center">
<img src="./assets/images/demoCellsValue.png" alt="proper cells value" width="320px" height=160px>
</p>

### `shuffledData.getFirstWordIndexes`
getFirstWordIndexes returns an array which provides indexes of the first word in 3 x 3 matrices.

```const firstWordIndexes = shuffledData.getFirstWordIndexes;```

```
[
    [2,2],
    [2,1],
    [1,2],
    [0,2],
    [0,1]
]
```
<p align="center">
<img src="./assets/images/getFirstWordIndexes.png" alt="first word indexes" width="320px" height=160px>
</p>

### `shuffledData.getSecondWordIndexes`
getSecondWordIndexes returns an array which provides indexes of the second word in 3 x 3 matrices.

```const secondWordIndexes = shuffledData.getSecondWordIndexes;```
```
[
    [1,1],
    [0,0],
    [1,0],
    [2,0]
]
```

<p align="center">
<img src="./assets/images/getSecondWordIndexes.png" alt="second word indexes" width="320px" height=160px>
</p>

## TODO 

* Improve the code so this package would work with (n x m ) matrices.
* Add tests included edge cases.