@stacksjs/push 0.47.4 → 0.48.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +24 -42
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -1,62 +1,36 @@
1
- # Stacks Notifications
1
+ # Stacks Chat
2
2
 
3
- wip
3
+ Stacks Push is driver system for Pushing messages through apps.
4
4
 
5
5
  ## ☘️ Features
6
6
 
7
- wip
8
-
9
- - ⚡️
10
-
11
- wip
7
+ - 📦 Push Messages
12
8
 
13
9
  ## 🤖 Usage
14
10
 
15
- wip
16
-
17
11
  ```bash
18
- pnpm i -D @stacksjs/notifications
12
+ pnpm i -D @stacksjs/push
19
13
  ```
20
14
 
21
- Now, you can use it in your project:
15
+ You may now use it in your project:
22
16
 
23
- ```js
24
- import notifications from '@stacksjs/notifications'
25
-
26
- // wip
27
- ```
28
-
29
- ## 🤖 Drivers
30
-
31
- ### Email
17
+ wip
32
18
 
33
- - Sendgrid
34
- - Mailgun
35
- - Mailjet
36
- - Netcore
37
- - Nodemailer
38
- - Post Mark
39
- - Ses
40
- - Mandrill
41
- - EmailJS
19
+ ### Drivers
42
20
 
43
- ### SMS
21
+ Drivers are configured with the following environment variables:
44
22
 
45
- - Twilio
46
- - Nexmo
47
- - Gupshup
48
- - Plivo
49
- - SMS77
50
- - SNS
51
- - Telnyx
52
- - Termii
23
+ #### Discord
53
24
 
54
- ### Chat
25
+ - None
55
26
 
56
- - Discord
57
- - Slack
27
+ #### Slack
58
28
 
59
- Learn more in the docs.
29
+ ```bash
30
+ SLACK_APPLICATION_ID=SAID123
31
+ SLACK_CLIENT_ID=SCID123
32
+ SLACK_SECRET_KEY=SSK123
33
+ ```
60
34
 
61
35
  ## 🧪 Testing
62
36
 
@@ -82,6 +56,14 @@ For casual chit-chat with others using this package:
82
56
 
83
57
  [Join the Stacks Discord Server](https://discord.ow3.org)
84
58
 
59
+ ## 🙏🏼 Credits
60
+
61
+ Many thanks to the following core technologies & people who have contributed to this package:
62
+
63
+ - [Chris Breuer](https://github.com/chrisbbreuer)
64
+ - [Novu](https://novu.co/)
65
+ - [All Contributors](../../contributors)
66
+
85
67
  ## 📄 License
86
68
 
87
69
  The MIT License (MIT). Please see [LICENSE](https://github.com/stacksjs/stacks/tree/main/LICENSE.md) for more information.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@stacksjs/push",
3
3
  "type": "module",
4
- "version": "0.47.4",
4
+ "version": "0.48.1",
5
5
  "packageManager": "pnpm@7.21.0",
6
6
  "description": "The Stacks Push integration",
7
7
  "author": "Chris Breuer",
@@ -41,15 +41,15 @@
41
41
  "@maizzle/framework": "latest",
42
42
  "@novu/node": "^0.10.0",
43
43
  "@novu/stateless": "^0.10.0",
44
- "@stacksjs/cli": "0.47.4",
45
- "@stacksjs/config": "0.47.4",
46
- "@stacksjs/error-handling": "0.47.4",
47
- "@stacksjs/types": "0.47.4"
44
+ "@stacksjs/cli": "0.48.1",
45
+ "@stacksjs/config": "0.48.1",
46
+ "@stacksjs/error-handling": "0.48.1",
47
+ "@stacksjs/types": "0.48.1"
48
48
  },
49
49
  "devDependencies": {
50
50
  "mkdist": "^1.0.0",
51
51
  "typescript": "^4.9.4",
52
- "@stacksjs/testing": "0.47.4"
52
+ "@stacksjs/testing": "0.48.1"
53
53
  },
54
54
  "scripts": {
55
55
  "build": "mkdist -d",