Skip to content

Commit f6f1985

Browse files
authored
Merge pull request #50 from weaponsforge/dev
v1.2.3
2 parents c25c4a6 + 3a28732 commit f6f1985

4 files changed

Lines changed: 18 additions & 5 deletions

File tree

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
NPM library and CLI for sending text and HTML emails using Gmail SMTP with Google OAuth2.
44

55
> [!TIP]
6+
> - **Run via npx (no installation required)**
7+
> - Requirements: NodeJS LTS v24.11.0 or later
8+
> - Run `npx @weaponsforge/sendemail --help`
9+
>
610
> - **Node.js package**<br>
711
> A Node.js package is available at https://www.npmjs.com/package/@weaponsforge/sendemail
812
>
@@ -290,6 +294,10 @@ This script runs automatically after `"npm run transpile"`, copying the `"/app/s
290294

291295
### C. CLI 💻
292296

297+
### `npm start`
298+
299+
Shorthand for `"npm run sendemail"`
300+
293301
### `npm run sendemail`
294302

295303
Sends text and HTML emails using the command line interface (CLI) with transpiled JavaScript.

app/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

app/package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@weaponsforge/sendemail",
3-
"version": "1.2.2",
3+
"version": "1.2.3",
44
"description": "Sends emails using Gmail SMTP with username/pw or Google OAuth2",
55
"main": "dist/index.js",
66
"types": "./dist/index.d.ts",
@@ -9,7 +9,7 @@
99
"node": ">=24"
1010
},
1111
"bin": {
12-
"sendemail": "./dist/scripts/cli/send.js"
12+
"sendemail": "dist/scripts/cli/send.js"
1313
},
1414
"exports": {
1515
".": {
@@ -25,6 +25,7 @@
2525
"LICENSE"
2626
],
2727
"scripts": {
28+
"start": "node ./dist/scripts/cli/send.js",
2829
"dev": "vitest",
2930
"transpile": "tsc -p tsconfig.prod.json && tsc-alias && npm run copy:files",
3031
"transpile:noemit": "tsc -p tsconfig.json --noEmit",

docs/README_NPM.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ NPM library for sending text and HTML emails using Gmail SMTP with Google OAuth2
44

55
### CLI Available
66

7+
> - **Run via npx (no installation required)**
8+
> - Requirements: NodeJS LTS v24.11.0 or later
9+
> - Run `npx @weaponsforge/sendemail --help`
10+
>
711
> - **Pre-compiled Windows binaries**<br>
812
> 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.
913
>
@@ -47,7 +51,7 @@ NPM library for sending text and HTML emails using Gmail SMTP with Google OAuth2
4751

4852
## 🆕 Quickstart
4953

50-
1. Install library.
54+
1. Install the library.
5155
```bash
5256
npm i @weaponsforge/sendemail
5357
```

0 commit comments

Comments
 (0)