Skip to content

Commit 35a426e

Browse files
committed
docs: update READMEs
- Display Windows CLI gif demo - Update dependency versions - Bump to version patch v2.0.2
1 parent 0131fbb commit 35a426e

5 files changed

Lines changed: 31 additions & 25 deletions

File tree

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
NPM library and CLI for sending text and HTML emails using Gmail SMTP with Google OAuth2.
44

5+
[![DeepWiki](https://img.shields.io/badge/DeepWiki-weaponsforge%2Fsend--email-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/weaponsforge/send-email)
6+
<!-- DeepWiki badge generated by https://deepwiki.ryoppippi.com/ -->
7+
58
> [!TIP]
69
> - **Run via npx (no installation required)**
710
> - Requirements: NodeJS LTS v24.11.0 or later
@@ -16,6 +19,10 @@ NPM library and CLI for sending text and HTML emails using Gmail SMTP with Googl
1619
> - **Docker image**<br>
1720
> A Docker image is available at https://hub.docker.com/r/weaponsforge/sendemail
1821
22+
**Windows Binary**
23+
24+
![sendemail windows cli](/docs/sendemail.gif)
25+
1926
### Table of Contents
2027

2128
- [Requirements](#-requirements)
@@ -49,15 +56,14 @@ NPM library and CLI for sending text and HTML emails using Gmail SMTP with Googl
4956

5057
(Installed via npm)
5158

52-
1. [googleapis](https://www.npmjs.com/package/googleapis) `v171.4.0` - Manages Gmail token access
53-
2. [nodemailer](https://www.npmjs.com/package/nodemailer) `v8.0.1` - Sends emails using various transport options
54-
3. [typescript](https://www.npmjs.com/package/typescript) `v5.9.3` - Compile-time error checker
55-
4. [tsx](https://www.npmjs.com/package/tsx) `v4.21.0` - Runs TS files in development mode
56-
5. [vitest](https://www.npmjs.com/package/vitest) `v4.0.18` - Runs tests
57-
6. [commander](https://www.npmjs.com/package/commander) `v14.0.3` - CLI library
58-
7. [sanitize-html](https://www.npmjs.com/package/sanitize-html) `v2.17.1` - Sanitizes WYSIWYG HTML input
59-
8. [zod](https://www.npmjs.com/package/zod) `v3.24.2` - Run-time input validation
60-
9. [ejs](https://www.npmjs.com/package/ejs) `v4.0.1` - Composes HTML with dynamic text content
59+
1. [nodemailer](https://www.npmjs.com/package/nodemailer) `v8.0.1` - Sends emails using various transport options
60+
2. [typescript](https://www.npmjs.com/package/typescript) `v6.0.3` - Compile-time error checker
61+
3. [tsx](https://www.npmjs.com/package/tsx) `v4.22.4` - Runs TS files in development mode
62+
4. [vitest](https://www.npmjs.com/package/vitest) `v4.1.9` - Runs tests
63+
5. [commander](https://www.npmjs.com/package/commander) `v15.0.0` - CLI library
64+
6. [sanitize-html](https://www.npmjs.com/package/sanitize-html) `v2.17.5` - Sanitizes WYSIWYG HTML input
65+
7. [zod](https://www.npmjs.com/package/zod) `v3.24.2` - Run-time input validation
66+
8. [ejs](https://www.npmjs.com/package/ejs) `v4.0.1` - Composes HTML with dynamic text content
6167

6268
</details>
6369
<br>
@@ -106,7 +112,7 @@ We welcome contributions! Please see [CONTRIBUTING.md](/CONTRIBUTING.md) and the
106112
npm run sendemail -- html \
107113
-s "WYSIWYG Email" \
108114
-w "<div style='width:100px; height:100px; border:5px solid blue; border-radius: 3px; padding: 8px; text-align: center; background-color: azure;'><h3>Hello, World</h3></div>" \
109-
-r "tester@gmail.com"
115+
-r tester@gmail.com
110116
```
111117

112118
> 💡 **TIP:** Development mode via `"sendemail:dev"` skips transpilation

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: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@weaponsforge/sendemail",
3-
"version": "2.0.1",
3+
"version": "2.0.2",
44
"description": "Sends emails using Gmail SMTP with username/pw or Google OAuth2",
55
"main": "dist/index.js",
66
"types": "./dist/index.d.ts",

docs/README_NPM.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
NPM library for sending text and HTML emails using Gmail SMTP with Google OAuth2.
44

5+
[![DeepWiki](https://img.shields.io/badge/DeepWiki-weaponsforge%2Fsend--email-blue.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAyCAYAAAAnWDnqAAAAAXNSR0IArs4c6QAAA05JREFUaEPtmUtyEzEQhtWTQyQLHNak2AB7ZnyXZMEjXMGeK/AIi+QuHrMnbChYY7MIh8g01fJoopFb0uhhEqqcbWTp06/uv1saEDv4O3n3dV60RfP947Mm9/SQc0ICFQgzfc4CYZoTPAswgSJCCUJUnAAoRHOAUOcATwbmVLWdGoH//PB8mnKqScAhsD0kYP3j/Yt5LPQe2KvcXmGvRHcDnpxfL2zOYJ1mFwrryWTz0advv1Ut4CJgf5uhDuDj5eUcAUoahrdY/56ebRWeraTjMt/00Sh3UDtjgHtQNHwcRGOC98BJEAEymycmYcWwOprTgcB6VZ5JK5TAJ+fXGLBm3FDAmn6oPPjR4rKCAoJCal2eAiQp2x0vxTPB3ALO2CRkwmDy5WohzBDwSEFKRwPbknEggCPB/imwrycgxX2NzoMCHhPkDwqYMr9tRcP5qNrMZHkVnOjRMWwLCcr8ohBVb1OMjxLwGCvjTikrsBOiA6fNyCrm8V1rP93iVPpwaE+gO0SsWmPiXB+jikdf6SizrT5qKasx5j8ABbHpFTx+vFXp9EnYQmLx02h1QTTrl6eDqxLnGjporxl3NL3agEvXdT0WmEost648sQOYAeJS9Q7bfUVoMGnjo4AZdUMQku50McDcMWcBPvr0SzbTAFDfvJqwLzgxwATnCgnp4wDl6Aa+Ax283gghmj+vj7feE2KBBRMW3FzOpLOADl0Isb5587h/U4gGvkt5v60Z1VLG8BhYjbzRwyQZemwAd6cCR5/XFWLYZRIMpX39AR0tjaGGiGzLVyhse5C9RKC6ai42ppWPKiBagOvaYk8lO7DajerabOZP46Lby5wKjw1HCRx7p9sVMOWGzb/vA1hwiWc6jm3MvQDTogQkiqIhJV0nBQBTU+3okKCFDy9WwferkHjtxib7t3xIUQtHxnIwtx4mpg26/HfwVNVDb4oI9RHmx5WGelRVlrtiw43zboCLaxv46AZeB3IlTkwouebTr1y2NjSpHz68WNFjHvupy3q8TFn3Hos2IAk4Ju5dCo8B3wP7VPr/FGaKiG+T+v+TQqIrOqMTL1VdWV1DdmcbO8KXBz6esmYWYKPwDL5b5FA1a0hwapHiom0r/cKaoqr+27/XcrS5UwSMbQAAAABJRU5ErkJggg==)](https://deepwiki.com/weaponsforge/send-email)
6+
<!-- DeepWiki badge generated by https://deepwiki.ryoppippi.com/ -->
7+
8+
59
### CLI Available
610

711
> - **Run via npx (no installation required)**
@@ -41,12 +45,11 @@ NPM library for sending text and HTML emails using Gmail SMTP with Google OAuth2
4145

4246
(Installed via npm)
4347

44-
1. [googleapis](https://www.npmjs.com/package/googleapis) `v171.4.0` - Manages Gmail token access
45-
2. [nodemailer](https://www.npmjs.com/package/nodemailer) `v8.0.1` - Sends emails using various transport options
46-
3. [commander](https://www.npmjs.com/package/commander) `v14.0.3` - CLI library
47-
4. [sanitize-html](https://www.npmjs.com/package/sanitize-html) `v2.17.1` - Sanitizes WYSIWYG HTML input
48-
5. [zod](https://www.npmjs.com/package/zod) `v3.24.2` - Run-time input validation
49-
6. [ejs](https://www.npmjs.com/package/ejs) `v4.0.1` - Composes HTML with dynamic text content
48+
1. [nodemailer](https://www.npmjs.com/package/nodemailer) `v8.0.1` - Sends emails using various transport options
49+
2. [commander](https://www.npmjs.com/package/commander) `v15.0.0` - CLI library
50+
3. [sanitize-html](https://www.npmjs.com/package/sanitize-html) `v2.17.5` - Sanitizes WYSIWYG HTML input
51+
4. [zod](https://www.npmjs.com/package/zod) `v3.24.2` - Run-time input validation
52+
5. [ejs](https://www.npmjs.com/package/ejs) `v4.0.1` - Composes HTML with dynamic text content
5053

5154
</details>
5255
<br>
@@ -138,22 +141,19 @@ import { EmailSender } from '@weaponsforge/sendemail'
138141
// Initializes the Nodemailer transport with Google OAuth2
139142
import { EmailTransport } from '@weaponsforge/sendemail'
140143

141-
// Manages API keys, methods and properties of the Google `OAuth2Client`
142-
import { GmailOAuthClient } from '@weaponsforge/sendemail'
143-
144144
// Wrapper around `ZodObject` and `ZodEffects` zod schemas
145145
import { SchemaValidator } from '@weaponsforge/sendemail'
146146

147147
// eg., extend (or override) the EmailSender class
148-
class MyOAuthClient extends GmailOAuthClient {
148+
class MyEmailClient extends EmailSender {
149149
sayHello (name = '') {
150150
console.log(`Hello, ${name}!`)
151151
}
152152
}
153153

154-
const client = new MyOAuthClient()
154+
const client = new MyEmailClient()
155155

156-
const token = await client.getAccessToken()
156+
const emailSchema = await client.schema
157157
client.sayHello('Tester')
158158
```
159159

docs/sendemail.gif

252 KB
Loading

0 commit comments

Comments
 (0)