Skip to content

fix: npm pkg warning #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
weaponsforge merged 3 commits into from
Feb 25, 2026
Merged

fix: npm pkg warning #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c69d1bd
fix: npm pkg warning in the bin field
weaponsforge Feb 25, 2026
bc722e0
docs: note cli usage via npx - no installation
weaponsforge Feb 25, 2026
4dd5b11
chore: add a start script
weaponsforge Feb 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**<br>
> A Node.js package is available at https://www.npmjs.com/package/@weaponsforge/sendemail
>
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions app/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions app/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -9,7 +9,7 @@
"node": ">=24"
},
"bin": {
"sendemail": "./dist/scripts/cli/send.js"
"sendemail": "dist/scripts/cli/send.js"
},
"exports": {
".": {
Expand All @@ -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",
Expand Down
6 changes: 5 additions & 1 deletion docs/README_NPM.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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**<br>
> 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.
>
Expand Down Expand Up @@ -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
```
Expand Down