Skip to content

Commit b18c2f9

Browse files
Merge pull request #31 from renderforest/update-API-doc
update API doc
2 parents a20b8c2 + f79735a commit b18c2f9

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

doc/API.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Environment variables(s):
99

1010
#### notifyError(...)
1111
``` javascript
12-
const SlackHooks = require('notification-hooks').Slack
12+
const SlackHooks = require('@renderforest/notification-hooks').Slack
1313

1414
const options = {
1515
channel: '#media-upload',
@@ -24,7 +24,7 @@ Environment variables(s):
2424

2525
#### notifyWarn(...)
2626
``` javascript
27-
const SlackHooks = require('notification-hooks').Slack
27+
const SlackHooks = require('@renderforest/notification-hooks').Slack
2828

2929
const options = {
3030
channel: '#backend',
@@ -39,7 +39,7 @@ Environment variables(s):
3939

4040
#### notifyInfo(...)
4141
``` javascript
42-
const SlackHooks = require('notification-hooks').Slack
42+
const SlackHooks = require('@renderforest/notification-hooks').Slack
4343

4444
const options = {
4545
channel: '#front',
@@ -49,5 +49,5 @@ Environment variables(s):
4949
username: '@john'
5050
}
5151

52-
SlackHooks.notifyError(options).then().catch()
52+
SlackHooks.notifyInfo(options).then().catch()
5353
```

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@renderforest/notification-hooks",
33
"description": "Notification hooks",
4-
"version": "2.1.0",
4+
"version": "2.1.1",
55
"author": "RenderForest LLC",
66
"bugs": {
77
"url": "https://github.com/renderforest/notification-hooks/issues"

0 commit comments

Comments
 (0)