Skip to content

Commit 2f204a7

Browse files
committed
📖 DOC: Introduce pkgreview.dev badge
1 parent 3577521 commit 2f204a7

File tree

2 files changed

+19
-10
lines changed

2 files changed

+19
-10
lines changed

README.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,20 @@
66

77
[![Type](https://img.shields.io/badge/type-CLI-yellow.svg?style=flat-square)](https://www.npmjs.com/package/bulk-mail-cli)
88
[![npm](https://img.shields.io/badge/npm-bulk--mail--cli-CB3837.svg?style=flat-square)](https://www.npmjs.com/package/bulk-mail-cli)
9-
[![Version](https://img.shields.io/badge/version-v2.0.0-green.svg?style=flat-square)](https://www.npmjs.com/package/bulk-mail-cli)
10-
[![](https://travis-ci.com/KumarAbhirup/bulk-mail-cli.svg?branch=master)](https://github.com/KumarAbhirup/bulk-mail-cli)
9+
[![Version](https://img.shields.io/npm/v/bulk-mail-cli?label=version&style=flat-square)](https://www.npmjs.com/package/bulk-mail-cli)
10+
[![Tests](https://travis-ci.com/adventmail/bulk-mail-cli.svg?branch=master)](https://github.com/KumarAbhirup/bulk-mail-cli)
1111
[![Twitter](https://img.shields.io/twitter/follow/kumar_abhirup.svg?style=social&label=@kumar_abhirup)](https://twitter.com/kumar_abhirup/)
1212
[![GitHub stars](https://img.shields.io/github/stars/KumarAbhirup/bulk-mail-cli.svg?style=social&label=Stars)](https://github.com/KumarAbhirup/bulk-mail-cli)
1313

14+
<br />
15+
16+
[![pkgreview.dev Rating](https://img.shields.io/pkgreview/stars/npm/bulk-mail-cli?label=pkgreview.dev%20Stars&style=for-the-badge)](https://pkgreview.dev/npm/bulk-mail-cli)
17+
[![pkgreview.dev Rating](https://img.shields.io/pkgreview/rating/npm/bulk-mail-cli?label=pkgreview.dev%20Rating&style=for-the-badge)](https://pkgreview.dev/npm/bulk-mail-cli)
18+
19+
| **Like us a lot?** Help others know why you like us! **Review this package on [pkgreview.dev](https://pkgreview.dev/npm/bulk-mail-cli)** || [![Review us on pkgreview.dev](https://i.ibb.co/McjVMfb/pkgreview-dev.jpg)](https://pkgreview.dev/npm/bulk-mail-cli) |
20+
| ---------------------------------------------------------------------------------------------------------------------------------------- | --- | -------------------------------------------------------------------------------------------------------------------- |
21+
22+
1423
</div>
1524

1625
<br /><br />
@@ -56,7 +65,7 @@ Ever felt a quick need to shoot a fabulous mail to your subscribers? Without any
5665
Assuming that you have `node` and `npm` installed... Run the following in your terminal.
5766

5867
```bash
59-
$ npm i -g bulk-mail-cli
68+
npm i -g bulk-mail-cli
6069
```
6170

6271
<br />
@@ -72,7 +81,7 @@ Just run `bulkmail support` in your terminal to see what commands and flags you
7281
To generate demo files, use the following command.
7382

7483
```bash
75-
$ bulkmail demo
84+
bulkmail demo
7685
```
7786

7887
<br />
@@ -118,7 +127,7 @@ $ bulkmail demo
118127
## Send the Mail 🔰🔰🔰
119128

120129
```bash
121-
$ EMAIL="chandlerbing@friends.com" PASSWORD="secret" bulkmail -f bulkmail.json # reference the configuration file here
130+
EMAIL="chandlerbing@friends.com" PASSWORD="secret" bulkmail -f bulkmail.json # reference the configuration file here
122131
```
123132

124133
That will start the mailing process! After every mail it sends, it updates the configuration file with the emails that you sent the message to. So that when you run the same campaign next time, it will resume from where you paused. **To start over, you can append the `--restart` flag to the command.**
@@ -127,7 +136,7 @@ That will start the mailing process! After every mail it sends, it updates the c
127136

128137
## Writing data in CSV
129138

130-
### List emails the right way!
139+
### List emails the right way
131140

132141
If you use **WordPress**, you may just import the CSV file of users by using [this plugin](https://wordpress.org/plugins/users-customers-import-export-for-wp-woocommerce/).
133142

@@ -162,10 +171,10 @@ You can also define `PASSWORD` environment variable so that you don't directly t
162171
#### Command
163172

164173
```bash
165-
$ PASSWORD=ThisIsAPassword bulkmail --file bulkmail.json
174+
PASSWORD=ThisIsAPassword bulkmail --file bulkmail.json
166175
```
167176

168-
#### Configuration:
177+
#### Configuration
169178

170179
```
171180
{

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "bulk-mail-cli",
3-
"version": "2.0.6",
3+
"version": "2.0.7",
44
"description": "Do quick, hassle-free email marketing with this small but very powerful tool! 🔥",
55
"main": "dist/src/index.js",
66
"scripts": {
@@ -45,7 +45,7 @@
4545
"homepage": "https://github.com/adventmail/bulk-mail-cli#readme",
4646
"devDependencies": {
4747
"@types/csvtojson": "^1.1.5",
48-
"@types/node": "^12.7.3",
48+
"@types/node": "^13.7.7",
4949
"@types/node-cron": "^2.0.2",
5050
"@types/nodemailer": "^6.4.0",
5151
"@typescript-eslint/eslint-plugin": "^2.0.0",

0 commit comments

Comments
 (0)