RELNOTE

The relnote command helps create notifications about release dates by injecting a JavaScript file into an HTML file and configuring notification settings. It allows you to dynamically set variables and manage notification timings through command-line options.

Features

• Injects JavaScript: Embeds a specified JavaScript file into an HTML file.
• Configurable Variables: Sets apiData, deployDate, and timing settings for notifications.
• API and deploy Options: Supports both API data URLs and specific release dates.
• Customizable Timing: Allows customization of warning activation and dismissal times.

Installation

1. Download the relnote script.

   git clone https://github.com/Sulaymon-Dev20/relnote.git
   

2. Make it executable:

   chmod +x install.sh
   

3. Move it to a directory in your PATH:

   sudo bash install.sh
   

Usage

   relnote [OPTIONS]

Options

• -f, --file Specify the HTML file path (default is index.html).

• -j, --js Specify the JavaScript file path (default is /usr/share/relnote/note.js).

• -u, --url Specify the URL for API data.

• -d, --deploy Specify the deploy time in the format 'Sun Aug 25 12:03:19 CDT 2024'.

• -wa, --warning-activation Set the warning activation time in milliseconds (default is 86400000).

• -wd, --warning-dismissal Set the warning dismissal time in milliseconds (default is 60000).

• -h, --help Display this help message.

Examples

1. Basic usage with default settings:

   relnote
   

2. Inject note.js into a custom HTML file and set a release date:

   relnote -f myfile.html -j /path/to/note.js -d "Sun Sep 15 10:00:00 CDT 2024"
   

3. Specify API data URL and adjust warning timings:

   relnote -f custom.html -u http://example.com/api -wa 3600000 -wd 30000
   

Relnote Command Explanation

The command you provided looks like this:

Explanation

• --deploy 'TODAY': This sets the deployment date to TODAY. The notification will trigger on the current day.
• --warning-activation=86400000: This sets the warning activation to 24 hours before the deployment, as 86400000 milliseconds = 1 day.
• --warning-dismissal=600: The warning will automatically disappear after 600 milliseconds (0.6 seconds).

If you'd like the warning to remain visible longer, increase the dismissal time. For example, to set the warning to stay for 10 minutes, use:

License

This project is licensed under the MIT License.

Author

• Name: Nuriddin Bobonorov
• Email: sulaymon1w@gmail.com
• Website: portfolio