# scoreyboard

> [![CircleCI](https://circleci.com/gh/TheAdamizer/scoreyboard.svg?style=svg)](https://circleci.com/gh/TheAdamizer/scoreyboard) [![codecov](https://codecov.io/gh/TheAdamizer/scoreyboard/branch/master/graph/badge.svg?token=YKrehvJB0z)](https://codecov.io/gh

Latest version **0.0.4** (published 2020-01-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install scoreyboard
pnpm add scoreyboard
yarn add scoreyboard
bun add scoreyboard
```

Provides the command `scoreyboard`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2020-01-14 |
| First published | 2020-01-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 23.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Adam Van Antwerp |
| Maintainers | theadamizer |

## Links

- npm: https://www.npmjs.com/package/scoreyboard
- Repository: https://github.com/TheAdamizer/scoreyboard
- Homepage: https://github.com/TheAdamizer/scoreyboard#readme
- Issues: https://github.com/TheAdamizer/scoreyboard/issues
- npm.io page: https://npm.io/package/scoreyboard

## Dependencies (4)

- [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.8.3
- [@babel/core](https://npm.io/package/@babel/core.md) ^7.8.3
- [@babel/polyfill](https://npm.io/package/@babel/polyfill.md) ^7.8.3
- [@babel/preset-env](https://npm.io/package/@babel/preset-env.md) ^7.8.3

## Recent versions

- 0.0.4 (latest) — 2020-01-14
- 0.0.3 — 2020-01-14
- 0.0.2 — 2020-01-14
- 0.0.1 — 2020-01-14

## README

# scoreyboard: A simple soccer league scorer
[![CircleCI](https://circleci.com/gh/TheAdamizer/scoreyboard.svg?style=svg)](https://circleci.com/gh/TheAdamizer/scoreyboard)
[![codecov](https://codecov.io/gh/TheAdamizer/scoreyboard/branch/master/graph/badge.svg?token=YKrehvJB0z)](https://codecov.io/gh/TheAdamizer/scoreyboard)

### Installation:
    1. Install node: https://nodejs.org/en/

    2a. Install package globally with `npm i -g scoreyboard` or
  
    2a. Download repo directly, run `npm install` and then run `node ./bin/index.js` from the base directory


### Usage:
  ##### Without any parameters:
  `$ scoreyboard`
  
  Will listen to scores piped in from STDIN
  For example `$ cat "./sample-input.txt" | scoreyboard`
  
  
  ##### With a file path:
  `$ scoreyboard "./sample-input.txt"`
  
  Will read the game scores from the specified file directly

  ##### With the sample param:
  `$ scoreyboard --sample`

  Will read the game scores from the original sample file


### Testing:
  `$ npm run test`

---
_Source: https://npm.io/package/scoreyboard · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._