alexarank

A simple node package to get Alexa traffic rank for a domain or URL
Log | Files | Refs | README | LICENSE

README.md (927B)


      1 # alexarank [![Build Status][1]][2]
      2 
      3 ## Description
      4 
      5 A simple node package to get Alexa traffic rank for a domain or URL.
      6 
      7 ## Installation
      8 
      9 Install the module:
     10 
     11 	npm install -g alexarank
     12 
     13 
     14 ## Usage example
     15 
     16 Using the module is pretty straightforward:
     17 
     18 	var alexa = require('alexarank');
     19 
     20 	alexa("http://www.echojs.com/", function(error, result) {
     21 	    if (!error) {
     22 	        console.log(JSON.stringify(result));
     23 	    } else {
     24 	        console.log(error);
     25 	    }
     26 	});
     27 
     28 
     29 ## CLI tool
     30 
     31 There is a bundled `alexarank` CLI tool:
     32 
     33 	USAGE   : alexarank domain
     34 
     35 	EXAMPLES: alexarank http://www.echojs.com
     36 	          alexarank echojs.com
     37 
     38 ## License
     39 
     40 alexarank is released under the BSD 2-Clause license. See `LICENSE` file for
     41 details.
     42 
     43 ## Author
     44 
     45 alexarank is developed by Frederic Cambus.
     46 
     47 - Site: https://www.cambus.net
     48 
     49 [1]: https://api.travis-ci.org/fcambus/alexarank.png?branch=master
     50 [2]: https://travis-ci.org/fcambus/alexarank