# pace-timer

> Pace yourself with this command line timer

Latest version **0.0.1** (published 2022-10-28) · ISC license · 0 weekly downloads

## Install

```sh
npm install pace-timer
pnpm add pace-timer
yarn add pace-timer
bun add pace-timer
```

Provides the command `pace`.

## Health

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

Positive: has types; no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2022-10-28 |
| First published | 2022-10-28 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=12.0.0 |
| Dependencies | 2 |
| Unpacked size | 188.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Jason Swartz @swartzrock |
| Maintainers | swartzrock |
| Keywords | timer, ansi |

## Links

- npm: https://www.npmjs.com/package/pace-timer
- Repository: https://github.com/swartzrock/pace
- Issues: https://github.com/swartzrock/pace/issues
- npm.io page: https://npm.io/package/pace-timer

## Dependencies (2)

- [@oclif/core](https://npm.io/package/@oclif/core.md) ^1
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5

## Recent versions

- 0.0.1 (latest) — 2022-10-28

## README

<p align="center">
  <img width="400" height="381" src="media/logo.png" alt="logo"><br><h1></h1>
<p align="center">Typescript app with multiple visual countdown timers</p>


<p align="center">
  <a href="#about-pace">About Pace</a> •
  <a href="#usage">Usage</a> •
  <a href="#contributing">Contributing</a> •
  <a href="#built-with">Built With</a>
</p>

<p align="center">
	
![demo](media/all_renderers.gif)
</p>

## About Pace
Pace is a Typescript app that performs a countdown timer using a visual renderer on the command line. 
Choose a renderer when you run the app, or run preview to see a representation of all the renderers.

## Usage
```sh
USAGE
  $ pace [DURATION] [RENDERER]

ARGUMENTS
  DURATION  duration in (m)inutes and (s)seconds (eg 3m10s = 190 seconds)
  RENDERER  the timer renderer:
            bar, bigtext, circles, colorwheel, colossal, pie, renderers, shuffle, slant, sweep

DESCRIPTION
  Displays a progress timer

EXAMPLES
  $ pace 2.5m pie
```

### The Shuffle Renderer

![demo](media/pace-shuffle.gif)

Use the `shuffle` renderer to preview all renderers in action. This renderer switches to another renderer every 10 seconds.

```sh 
pace 5m shuffle
```


### Preview All Renderers
```sh 
pace tools preview
```


## Contributing
It would be great to see more renderers! To write a new renderer add a subclass of `src/renderers/TimerRenderer` and register it with
a short name in `src/renderers/AllRenderers`. 

### Preview All Available Figlet Fonts
```sh 
pace tools allfonts
```

### Preview All Available Colors and Gradients
```sh 
pace tools colorblocks
```

### Notes
* Renderers should not store state between callbacks, since the `shuffle` renderer and `tools preview` command depend on calling renderers at selected intervals.

## Built With
* Typescript
* Yarn
* Oclif

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