# zennn

> Easy to manage, simple asynchronous timers rendered in the terminal for presentation & host management.

Latest version **1.1.3** (published 2020-06-24) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2020-06-24 |
| First published | 2020-06-24 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 15.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | matbub |

## Links

- npm: https://www.npmjs.com/package/zennn
- Repository: https://github.com/hi-matbub/zennn
- Homepage: https://github.com/hi-matbub/zennn#readme
- Issues: https://github.com/hi-matbub/zennn/issues
- npm.io page: https://npm.io/package/zennn

## Dependencies (5)

- [colors](https://npm.io/package/colors.md) ^1.4.0
- [moment](https://npm.io/package/moment.md) ^2.27.0
- [inquirer](https://npm.io/package/inquirer.md) ^7.2.0
- [countdown](https://npm.io/package/countdown.md) ^2.6.0
- [unix-timestamp](https://npm.io/package/unix-timestamp.md) ^0.2.0

## Recent versions

- 1.1.3 (latest) — 2020-06-24
- 1.1.2 — 2020-06-24
- 1.1.1 — 2020-06-24

## README

# Zennn

Easy to manage, simple asynchronous timers rendered in the terminal for presentation & host management.

[![Build Status](https://travis-ci.com/hi-matbub/zennn-cl.svg?branch=master)](https://travis-ci.com/hi-matbub/zennn-cl)
![airbnb](https://img.shields.io/badge/code%20style-airbnb-brightgreen.svg?style=flat-square)
[![prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

## Demo

![zen](https://i.imgur.com/mK7VfjD.gif)

### Why the terminal?

When real estate on your screen matters, the terminal is your friend. That and the _simplicity_.

## Install 

From your terminal, install Zennn as a dependency `npm i zennn`

### Use

After requiring Zennn into your project, initalizing the timer functions are a simple matter of setting timers via an _array of objects_, within the paramaters of our function.

eg.

````
var { Zennn } = require('zennn');

Zennn([
  { name: 'intro', time: '1m' },
  { name: 'warm-ups', time: '5m' },
  { name: 'code-review', time: '3m' },
]);

````

to run the timers, simply execute `node <file-name>.js` from within your terminal. 


#### Whats happening here?

Referring to the example above, Zennn will asynchronously run through the timers listed in order. So, once **intro** has reached 0, **warm-ups** will begin and so on until the array is empty.

## Paramaters

key | type
--- | ---
name | string
time | string

We only specify by minutes, eg `time: '17m'` and anything over 60 minutes will not render properly. 

If you would like to contribute, feel free to open a pull request. :thumbsup:

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