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

Info/Doc style updates to core/pi nodes

Browse Source
This commit is contained in:
Dave Conway-Jones
2016-03-02 13:18:24 +00:00
parent 741c57e627
commit eff8327971
25 changed files with 78 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
social/twitter/README.md
View File

@@ -7,14 +7,10 @@ The Twitter API will **NOT** deliver 100% of all tweets. This does **NOT** give
Tweets of who you follow will include their retweets and favourites.
**Note** : This is the same node as was in the core of Node-RED.
As of v0.10.8 it will be installed from here instead.
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-twitter
@@ -23,7 +19,7 @@ Usage
Provides two nodes - one to receive messages, and one to send.
###Input
### Input
Twitter input node. Can be used to search either:
@@ -33,11 +29,11 @@ Twitter input node. Can be used to search either:
Use **space** for *and*, and **comma** , for *or* when searching for multiple terms.
Sets the **msg.topic** to *tweets/* and then appends the senders screen name.
Sets the `msg.topic` to *tweets/* and then appends the senders screen name.
Sets **msg.location** to the tweeters location if known.
Sets `msg.location` to the tweeters location if known.
Sets **msg.tweet** to the full tweet object as documented by <a href="https://dev.twitter.com/overview/api/tweets">Twitter</a>.
Sets `msg.tweet` to the full tweet object as documented by <a href="https://dev.twitter.com/overview/api/tweets">Twitter</a>.
**Note:** when set to a specific user's tweets, or your direct messages, the node is subject to
Twitter's API rate limiting. If you deploy the flows multiple times within a 15 minute window, you may
@@ -45,14 +41,14 @@ exceed the limit and will see errors from the node. These errors will clear when
passes.
###Output
### Output
Tweets the **msg.payload**.
Tweets the `msg.payload`.
To send a Direct Message (DM) - use a payload like.
D {username} {message}
If **msg.media** exists and is a Buffer object, this node will treat it as an image and attach it to the tweet.
If `msg.media` exists and is a Buffer object, this node will treat it as an image and attach it to the tweet.
If **msg.params** exists and is an object of name:value pairs, this node will treat it as parameters for the update request.
If `msg.params` exists and is an object of name:value pairs, this node will treat it as parameters for the update request.

2
social/twitter/package.json
View File

@@ -1,6 +1,6 @@
{
"name" : "node-red-node-twitter",
"version" : "0.1.5",
"version" : "0.1.6",
"description" : "A Node-RED node to talk to Twitter",
"dependencies" : {
"twitter-ng": "0.6.2",