diff --git a/README.md b/README.md index e9e3621..6e27126 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,10 @@ NPM library and CLI for sending text and HTML emails using Gmail SMTP with Google OAuth2. > [!TIP] +> - **Run via npx (no installation required)** +> - Requirements: NodeJS LTS v24.11.0 or later +> - Run `npx @weaponsforge/sendemail --help` +> > - **Node.js package**
> A Node.js package is available at https://www.npmjs.com/package/@weaponsforge/sendemail > @@ -290,6 +294,10 @@ This script runs automatically after `"npm run transpile"`, copying the `"/app/s ### C. CLI 💻 +### `npm start` + +Shorthand for `"npm run sendemail"` + ### `npm run sendemail` Sends text and HTML emails using the command line interface (CLI) with transpiled JavaScript. diff --git a/app/package-lock.json b/app/package-lock.json index 923f6bf..832eddc 100644 --- a/app/package-lock.json +++ b/app/package-lock.json @@ -1,12 +1,12 @@ { "name": "@weaponsforge/sendemail", - "version": "1.2.2", + "version": "1.2.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@weaponsforge/sendemail", - "version": "1.2.2", + "version": "1.2.3", "license": "MIT", "dependencies": { "commander": "^14.0.3", diff --git a/app/package.json b/app/package.json index 7ca3b61..15d4622 100644 --- a/app/package.json +++ b/app/package.json @@ -1,6 +1,6 @@ { "name": "@weaponsforge/sendemail", - "version": "1.2.2", + "version": "1.2.3", "description": "Sends emails using Gmail SMTP with username/pw or Google OAuth2", "main": "dist/index.js", "types": "./dist/index.d.ts", @@ -9,7 +9,7 @@ "node": ">=24" }, "bin": { - "sendemail": "./dist/scripts/cli/send.js" + "sendemail": "dist/scripts/cli/send.js" }, "exports": { ".": { @@ -25,6 +25,7 @@ "LICENSE" ], "scripts": { + "start": "node ./dist/scripts/cli/send.js", "dev": "vitest", "transpile": "tsc -p tsconfig.prod.json && tsc-alias && npm run copy:files", "transpile:noemit": "tsc -p tsconfig.json --noEmit", diff --git a/docs/README_NPM.md b/docs/README_NPM.md index fe4fb0a..a287b80 100644 --- a/docs/README_NPM.md +++ b/docs/README_NPM.md @@ -4,6 +4,10 @@ NPM library for sending text and HTML emails using Gmail SMTP with Google OAuth2 ### CLI Available +> - **Run via npx (no installation required)** +> - Requirements: NodeJS LTS v24.11.0 or later +> - Run `npx @weaponsforge/sendemail --help` +> > - **Pre-compiled Windows binaries**
> Pre-compiled [Windows binaries](https://github.com/weaponsforge/send-email?tab=readme-ov-file#%EF%B8%8F-building-the-windows-executable-file) are available for download in the latest [Releases](https://github.com/weaponsforge/send-email/releases) download page. > @@ -47,7 +51,7 @@ NPM library for sending text and HTML emails using Gmail SMTP with Google OAuth2 ## 🆕 Quickstart -1. Install library. +1. Install the library. ```bash npm i @weaponsforge/sendemail ```