@sinisterdev/rock-paper-scissor/README.md

A simple Rock-Paper-Scissor package

<div align="center">
  <br />
  <p>
    <img alt="CodeFactor Grade" src="https://img.shields.io/codefactor/grade/github/SinisterDeveloper/rock-paper-scissor/stable">
    <img alt="LICENSE" src="https://img.shields.io/github/license/SinisterDeveloper/rock-paper-scissor">
    <img alt="NPM Version" src="https://img.shields.io/npm/v/@sinisterdev/rock-paper-scissor">
    <img alt="NPM bundle size" src="https://img.shields.io/bundlephobia/min/@sinisterdev/rock-paper-scissor">
  </p>
</div>

# About

Integrate the "Rock-Paper-Scissors" game into your project using this simple package
* Get the results easily in the form of an object
* No bugs discovered till date
* Beginner friendly and fast

# Installation

```bash
npm install @sinisterdev/rock-paper-scissor
```

# Usage

```javascript
const game = require('@sinisterdev/rock-paper-scissor');

const result = game.play("rock"); /* Options: ["rock", "paper", "scissors"] */

console.log(result); // Returns an object containing result
console.log(result.success) // Returns aboolean whether the game functioned as expected
console.log(result.winner) // Returns a string containing the winner of round (player/computer/tie)
console.log(result.computer) // Retuns the computer's choice in form of string
```

# Result Object

`<Result>` is the Result object:

`<Result>.success` - Whether the game functioned as expected - Type: `boolean`

`<Result>.winner` - Winner of the round in the form of a string. Round may have resulted in a tie if `play()` function's force parameter is set to false. Type: `string`

`<Result>.computer` - The computer's choice in form of a string. Type: `string`

`<Result>.error` - The error message, `null` when operation is successful


# Issues

If you have any bugs, or if you want to request a feature, please open an issue