Rastrian / notify-me

A simple package to display notifications on your computer while coding

Notify Me

How To Use

Create notifications on your OS from terminal or code

Installation

npm install  @brunocroh/notify-me

then, you can create notification from your code like this:

import NotifyMe from "@brunocroh/notify-me";

NotifyMe.notify("Hello", "Something happen here", {
  sound: true,
});

OR

use it from your terminal

npm install -g  @brunocroh/notify-me

then

$ notify-me

Usage on Terminal

Running on terminal

A simple notification

$ notify-me

Change title and description of notification

$ notify-me -t "Title" -d "Description"

running after other program finished

$ pnpm install && notify-me -t "pnpm install" -d "Finished"

running after other program finished with sound

$ pnpm install && notify-me -t "pnpm install" -d "Finished" -s

---

Inside of your node project

import NotifyMe from "@brunocroh/notify-me";

const SomethingThatTookAlotOfTime = async () => {
  // code here
};

const main = async () => {
  await SomethingThatTookAlotOfTime();
  NotifyMe.notify("Hello", "Something happen here", {
    sound: true,
  });
};

Maintainers

• brunocroh