external-ip - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

package.json

 {
   "name": "external-ip",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Get your external IP, with fallbacks",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "./node_modules/mocha/bin/mocha"
   },
@@ -16,3 +16,5 @@ "repository": {
     "external",
-    "ip"
+    "ip",
+    "network",
+    "address"
   ],
@@ -19,0 +21,0 @@ "author": "J.Chaniotis",

README.md

@@ -1,10 +0,42 @@
-external-ip
-===========
+#external-ip
 
+[![Build Status](https://travis-ci.org/J-Chaniotis/external-ip.svg?branch=master)](https://travis-ci.org/J-Chaniotis/external-ip)
+
+![XKCD 865](http://imgs.xkcd.com/comics/nanobots.png)
+
+
+
 Get your external IP, with fallbacks
-npm install external-ip
 
-Todo:
-Complete tests
-Document
-Clean up some mess
+
+
+##Installation
+
+`npm install external-ip`
+
+
+##Usage
+
+
+```javascript
+var getIP = require('external-ip');
+
+getIP(function (err, ip) {
+    if (err) {
+        //Every service in the list failed to return an ip
+    } else {
+        //Do stuff        
+    }
+});
+
+```
+
+##Why?
+No idea, really. Just another lib that gives you your external ip address
+
+##Todo:
+* Complete tests
+* Document
+* Clean up some mess
+* Use custom urls
+* ...??

test/test.services.js

@@ -58,3 +58,3 @@ 'use strict';
 
-    it('Should return with an error with an invalid ip', function () {
+    it('Should return an error with an invalid ip', function () {
         var req = services.requestFactory(invalidRequest, 'batman');
@@ -61,0 +61,0 @@ req = services.addValidation(req);

Fixed alerts

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

9489

increased by6.67%

Number of package files

11

increased by10%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

42

increased by320%

No dependency changes