frodovdr/node-red-nodes
1
0
Fork 0
mirror of https://github.com/node-red/node-red-nodes.git synced 2025-03-01 10:37:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

update social nodes info style

Browse Source
This commit is contained in:
Dave Conway-Jones
2016-03-02 13:26:53 +00:00
parent 0880ad3987
commit b6116abce3
25 changed files with 104 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
social/irc/README.md
View File

@@ -9,8 +9,7 @@ As of v0.10.8 you will need to install it from here if still required.
Install
-------
Run the following command in the root directory of your Node-RED install, usually
this is ~/.node-red .
Run the following command in your Node-RED user directory - typically `~/.node-red`
npm install node-red-node-irc
@@ -27,7 +26,7 @@ Usage
Provides two nodes - one to receive messages, and one to send.
###Input
### Input
Connects to an IRC server to receive messages.</p>
@@ -35,29 +34,30 @@ The **IRC Server** field needs to be configured to a valid server, and
you must select a default channel to join. You may join multiple channels by
comma separating a list - #chan1,#chan2,#etc.
Incoming messages will appear as **msg.payload** on the first output, while
**msg.topic** will contain who it is from. **msg.to** contains either the name of the channel or PRIV in the case of a pm.
Incoming messages will appear as `msg.payload` on the first output, while
`msg.topic` will contain who it is from. `msg.to` contains either the name
of the channel or PRIV in the case of a pm.
The second output provides a **msg.payload** that has any status messages such as joins, parts, kicks etc.
The second output provides a `msg.payload` that has any status messages such as joins, parts, kicks etc.
The type of the status message is set as **msg.payload.type**. The possible status types are:
The type of the status message is set as `msg.payload.type`. The possible status types are:
- **message** : message is sent into the channel
- **pm** : private message to the bot
- **join** : a user joined the channel (also triggered when the bot joins a channel)
- **invite** : the bot is being invited to a channel
- **part** : a user leaves a channel
- **quit** : a user quits a channe
- **kick** : a user is kicked from a channel
- `message` : message is sent into the channel
- `pm` : private message to the bot
- `join` : a user joined the channel (also triggered when the bot joins a channel)
- `invite` : the bot is being invited to a channel
- `part` : a user leaves a channel
- `quit` : a user quits a channe
- `kick` : a user is kicked from a channel
###Output
### Output
Sends messages to a channel on an IRC server.
You can send just the **msg.payload**, or the complete **msg** object to the
selected channel, or you can select to use **msg.topic** to send the
**msg.payload** to a specific user (private message) or channel.
You can send just the `msg.payload`, or the complete `msg` object to the
selected channel, or you can select to use `msg.topic` to send the
`msg.payload` to a specific user (private message) or channel.
If multiple output channels are listed (eg. #chan1,#chan2), then the message
will be sent to all of them.
@@ -65,7 +65,7 @@ will be sent to all of them.
**Note:** you can only send to channels you have previously joined so they
MUST be specified in the node - even if you then decide to use a subset of them in msg.topic
You may send RAW commands using **msg.raw** - This must contain an array of
You may send RAW commands using `msg.raw` - This must contain an array of
parameters - eg.
["privmsg","#nodered","Hello world"]

2
social/irc/package.json
View File

@@ -1,6 +1,6 @@
{
"name" : "node-red-node-irc",
"version" : "0.0.5",
"version" : "0.0.7",
"description" : "A Node-RED node to talk to an IRC server",
"dependencies" : {
"irc" : "~0.4.0"