Skip to content

Commit 1419b29

Browse files
committed
docs: update wordings and text content
1 parent e5b42f9 commit 1419b29

7 files changed

Lines changed: 30 additions & 14 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ body:
1717
label: To Reproduce
1818
description: A step-by-step description of how to reproduce the issue, or a link to the reproducible repository.
1919
placeholder: |
20-
1. Start the application in development (`npm run sendemail:dev -- text -s "Title" -c "Sample body" -r a@gmail.com`)
20+
1. Start the application in development (npm run sendemail:dev -- text -s "Title" -c "Sample body" -r a@gmail.com)
2121
2. Press enter
2222
3. An error appears: "[ERROR] Failed to send text email: Required clientId"
2323
validations:

CONTRIBUTING.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@
22

33
Welcome to the **send-email** repository! We're excited to have you contribute to sending text and HTML-format emails more accessible via command line interface (CLI). To ensure a smooth contribution process for everyone, please follow these guidelines.
44

5+
> [!NOTE]
6+
> **Before Submitting**
7+
>
8+
> Check if there are other similar [PRs](https://github.com/weaponsforge/send-email/pulls).
9+
>
10+
> **New Feature**
11+
>
12+
> Before submitting a new feature, please open a **Feature Request issue** that clearly explains the proposed functionality and the reasons behind it. Once the request has been reviewed and approved, you may proceed with submitting a pull request.
13+
>
14+
> **Bug Fixes**
15+
>
16+
> Provide a detailed description of the bug (with live demo if possible). OR open a bug report and link it in your PR.
17+
518
## Getting Started
619

720
1. **Fork the Repository:** Start by forking the repository's `"dev"` branch to your GitHub account. This creates your own copy of the project where you can make changes.
@@ -64,4 +77,4 @@ Welcome to the **send-email** repository! We're excited to have you contribute
6477

6578
4. **Respect:** Respect the structure and formatting of the existing project. Follow the standard ESLint rules defined in its `app/eslint.config.mjs` file.
6679

67-
Thank you for contributing to the **send-email** repository. Your efforts help in sending emails more accessible for everyone.
80+
Thank you for contributing to the **send-email** repository. Your efforts help in making sending emails more accessible for everyone.

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ NPM library and CLI for sending text and HTML emails using Gmail SMTP with Googl
3939
```text
4040
Recommended:
4141
node: 24.11.0
42-
npm: 10.9.2
42+
npm: 11.6.1
4343
```
4444
3. Gmail Account
4545
- Google Cloud Platform project configured with [OAuth2](https://developers.google.com/workspace/guides/configure-oauth-consent) settings and [credentials](https://developers.google.com/workspace/guides/manage-credentials)
@@ -72,6 +72,7 @@ We welcome contributions! Please see [CONTRIBUTING.md](/CONTRIBUTING.md) and the
7272
- See **Installation # 4** for more information about these environment variables.
7373
2. Install dependencies.
7474
```bash
75+
cd app
7576
npm install
7677
```
7778
3. Transpile to JavaScript.
@@ -184,7 +185,7 @@ We welcome contributions! Please see [CONTRIBUTING.md](/CONTRIBUTING.md) and the
184185
docker run -it -v ${pwd}/app:/opt/app -v /opt/app/node_modules --rm weaponsforge/sendemail:dev <AVAILABLE_SCRIPT_OR_DOCKER_SCRIPT>
185186
```
186187

187-
- **Run a non-test TS file using Vite**<br>
188+
- **Run a non-test TS file using TypeScript Execute (tsx)**<br>
188189
(requires **Run an NPM script using Docker compose**)
189190
```bash
190191
docker exec -it weaponsforge-sendemail-dev npx tsx /opt/app/src/<PATH_TO_TS_FILE>.ts
@@ -375,8 +376,8 @@ Sends text and HTML emails using the command line interface (CLI) with transpile
375376
Options:
376377
-s, --subject <title> email subject or title enclosed in double-quotes
377378
-r, --recipients <emails> comma-separated list of email addresses
378-
-c, --content <text...> whitespace-delimited of text/paragraphs enclosed in double-quotes
379-
-w, --wysiwyg [html] optional HTML tags that form a WYSIWYG content enclosed in double-quotes
379+
-c, --content <text...> whitespace-delimited text/paragraphs enclosed in double-quotes
380+
-w, --wysiwyg [html] optional HTML tags that form a WYSIWYG content enclosed in double-quotes, using inline CSS styles
380381
-e, --env [path] path to .env file (optional)
381382
-h, --help display help for command
382383
```

app/src/lib/email/sender.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ class EmailSender extends EmailTransport implements IEmailSender {
4141
}
4242

4343
return await this.transporter!.sendMail({
44-
from: transportOptions.auth?.user || process.env.USER_EMAIL,
44+
from: transportOptions.auth?.user || process.env.GOOGLE_USER_EMAIL,
4545
to: receivers,
4646
subject,
4747
...(!isHtml && { text: content }), // Text email

app/src/scripts/cli/lib/meta.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ const CLI_ARGS = {
4444
CMD_HTML: {
4545
CONTENT_HTML: {
4646
OPTION: '-c, --content <text...>',
47-
DESCRIPTION: 'whitespace-delimited of text/paragraphs enclosed in double-quotes'
47+
DESCRIPTION: 'whitespace-delimited text/paragraphs enclosed in double-quotes'
4848
},
4949
CONTENT_WYSIWYG: {
5050
OPTION: '-w, --wysiwyg [html]',
51-
DESCRIPTION: 'optional HTML tags that form a WYSIWYG content enclosed in double-quotes'
51+
DESCRIPTION: 'optional HTML tags that form a WYSIWYG content enclosed in double-quotes, using inline CSS styles'
5252
},
5353
TEMPLATE_FILE: {
5454
OPTION: '-t, --template [path]',

docs/CODING_STYLE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ It follows the directory structure within the `/app` directory:
4747
**What you should (and shouldn't) edit**
4848

4949
**Edit:**
50-
- `src/**` (main TypeScript source)
51-
- Top-level build scripts in `scripts/**` (bash / automation)
50+
- `app/src/**` (main TypeScript source)
51+
- Top-level build scripts in `app/scripts/**` (bash / automation)
5252

5353
🏗️🚫 **Auto-generated (do not edit):**
5454
- `dist/**` (TS build output; local, published to NPM)
@@ -72,7 +72,7 @@ Do not edit manually.
7272

7373
#### 📂 scripts
7474

75-
Contains Build automation scripts (bash)
75+
Contains build automation scripts (bash)
7676

7777
#### 📂 src
7878

@@ -160,7 +160,7 @@ This folder contains the [EJS](https://github.com/mde/ejs) HTML template used in
160160
- Place test files in the `/src/__tests__` directory.
161161
- Name test files to match the target module, using the suffix: `*.test.ts`.
162162
> **Example:** `send.ts``send.test.ts`
163-
- **Selectively write tests** for critical or global, features, or business logic as needed.
163+
- **Selectively write tests** for critical or global features, or business logic as needed.
164164
- All code should pass `"npm test"` before commit.
165165

166166
@weaponsforge<br>

docs/README_NPM.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,14 @@ NPM library for sending text and HTML emails using Gmail SMTP with Google OAuth2
2929
```text
3030
Recommended:
3131
node: 24.11.0
32-
npm: 10.9.2
32+
npm: 11.6.1
3333
```
3434
2. Gmail Account
3535
- Google Cloud Platform project configured with [OAuth2](https://developers.google.com/workspace/guides/configure-oauth-consent) settings and [credentials](https://developers.google.com/workspace/guides/manage-credentials)
3636
- Read on the Google [Gmail](https://developers.google.com/gmail/api/guides), [SMTP and OAuth2 Setup](https://github.com/weaponsforge/email-sender?tab=readme-ov-file#using-the-oauth-20-playground) sections for more information
3737

38+
3. A `.env` file containing the environment variables described under **Quickstart - step #2**.
39+
3840
### Core Libraries/Frameworks
3941

4042
(Installed via npm)

0 commit comments

Comments
 (0)