birdwatch - npm Package Compare versions

Comparing version 0.3.3 to 0.3.4

package.json

 {
   "name": "birdwatch",
-  "version": "0.3.3",
+  "version": "0.3.4",
   "description": "Monitor and cache specific twitter feeds",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -53,6 +53,13 @@ # Birdwatch :baby_chick::watch:
 ### Cached HTML Tweet
- - If birdwatch can't find an `html` string on the returned tweet data, then it adds one for you, 
-   complete with twitter-ready HTML, thanks to [tweet-patch](https://github.com/radiovisual/tweet-patch). 
-   This means the plain-text hashtags, user-mentions and hyperlinks are converted to twitter-ready markup.
-
+ - If birdwatch can't find an `html` string on the returned tweet data, then it adds one for you using [tweet-patch](https://github.com/radiovisual/tweet-patch). 
+   This means the plain-text hashtags, user-mentions and hyperlinks are converted to twitter-ready HTML. Example below.
+   
+ - ```js
+   cached_tweets[0].text;
+   //=> "This is the #plaintext tweet"
+   
+   cached_tweets[0].html;
+   //=> "This is the <a href="https://twitter.com/hashtag/plaintext">#plaintext</a> tweet"
+   ```
+   
 ## API
@@ -133,3 +140,3 @@
 
-The callback gets sent to birdwatch.start() when complete
+The callback gets sent to birdwatch.start() when complete.
 
@@ -147,3 +154,2 @@ ### birdwatch.getCachedTweets()
 - [ ] Allow custom sorting rules
-- [ ] HTML-ify the cached tweets
 - [ ] More caching options (currently on-disk/in-memory only)
@@ -153,22 +159,3 @@
 
-The MIT License (MIT)
+MIT @ [Michael Wuergler](http://numetriclabs.com/)
 
-Copyright (c) 2015 Michael Wuergler
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

utils.js

@@ -317,3 +317,6 @@ 'use strict';
 
-    fs.writeFileSync('./cache/cached_tweets.json', JSON.stringify(dataToSave), {flag:'w'}, function (err) {
+    // first check to see if the .cache_tweets file exists
+    var cacheFile = "./cache/cached_tweets.json";
+
+    fs.writeFileSync(cacheFile, JSON.stringify(dataToSave), {flag:'w+'}, function (err) {
         if (err) {
@@ -320,0 +323,0 @@ report.logError(["Error saving cached_tweets.json in saveToCache()", err]);

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

Lines of code

544

increased by0.37%

Worsened metrics

Total package byte prevSize

34646

decreased by-2.14%

Number of lines in readme file

158

decreased by-7.6%

No dependency changes