1.1.3 • Published 4 years ago

zennn v1.1.3

Weekly downloads
2
License
ISC
Repository
github
Last release
4 years ago

Zennn

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

Build Status airbnb prettier

Demo

zen

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

keytype
namestring
timestring

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: