putt - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

package.json

@@ -5,3 +5,3 @@ {
   "description": "easily output text in lots of fun ways (speech, growl, email, ...)",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "homepage": "https://github.com/6/putt",
@@ -21,2 +21,3 @@ "repository": {
     ,"restler": "0.2.2"
+    ,"ntwitter": "0.2.9-2"
     ,"xml2js": "0.1.12"
@@ -23,0 +24,0 @@ },

README.md

@@ -17,4 +17,6 @@ **putt** is a node.js module that lets you easily output text in lots of fun ways. It wraps a bunch of other libraries to make this as simple as possible.
 
-TODO
+First, install [Node.JS](http://nodejs.org/) and [NPM](http://npmjs.org/) if you haven't already. Then, just `cd` into your project folder and run:
 
+    npm install putt
+
 # Usage
@@ -38,4 +40,2 @@
 
-Example usage:
-
 TODO
@@ -46,1 +46,14 @@
 TODO
+
+### Twitter
+
+First, [create a new Twitter application](https://dev.twitter.com/apps/new), and under the "Settings" tab, you will also want to give your app "Read and write" permissions so that we can write a tweet. Then, click the button at the bottom of the "Details" tab to generate an access token and secret.
+
+Next, provide those keys and secrets to putt when you call it:
+
+    putt({
+        consumer_key: "your consumer key",
+        consumer_secret: "your consumer secret",
+        access_token: "your access token",
+        access_token_secret: "your access token secret"
+    }).tweet("This text will be tweeted by your account");

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5728

increased by45.49%

Number of package files

7

increased by16.67%

Number of lines in readme file

57

increased by29.55%

Worsened metrics

Dependency count

7

increased by16.67%

Dependency changes

• + Addedntwitter@0.2.9-2

• + Addedcookies@0.1.6(transitive)

• + Addedkeygrip@0.1.7(transitive)

• + Addedntwitter@0.2.9-2(transitive)

• + Addedoauth@0.10.0(transitive)