Domai.nr - npm Package Compare versions

Comparing version 0.0.1 to 1.0.0

examples/express/routes/index.js

@@ -1,2 +0,2 @@
-var domainr = require('../../../domainr')
+var domainr = require('../../../lib/domainr')
 
@@ -3,0 +3,0 @@

package.json

 {
     "name": "Domai.nr"
-  , "version": "0.0.1"
+  , "version": "1.0.0"
   , "description": "A dead-simple way to utilize Domai.nr's JSON API"
@@ -8,7 +8,8 @@ , "keywords": [
        "domains",
-       "search"
+       "search",
+       "domain"
     ]
   , "repository": {
        "type": "git",
-       "url": "http://github.com/connormontgomery/domainr-node.git" 
+       "url": "http://github.com/connor/domainr-node.git" 
     }
@@ -22,5 +23,6 @@ , "maintainers": [{
   , "license": "MIT"
+  , "main": "./lib/domainr"
   , "dependencies": {
         "request" : "2.9.200"
     }
-}
+}

README.md

@@ -1,23 +0,130 @@
-The Domai.nr module is a dead-simple way to utilize Domai.nr's [JSON API](http://domai.nr/api/docs/json). It only comes with two methods: `search` and `info`, but that's all we need to get a ton of work done with the data behind Domai.nr.
+The Domai.nr NPM package is a dead-simple way to utilize Domai.nr's [JSON API](http://domai.nr/api/docs/json). It only comes with two methods: `search` and `info`, but that's all we need to get a ton of work done with the data behind Domai.nr.
 
-## Examples
 
+## Installation
 
-##### Express
+	$ npm install Domai.nr
 
-I prefer making my express apps driven by an internal API. By that, I mean I like to set up back-end routes that my front-end routes can receive data from. Included in the `/example` directory is a very rudimentary example of how one would go about using the doaminr module.
 
+## Documentation
 
-## Installation
+Like previously mentioned, this package comes with two methods available: `search`, and `info`. Both of them take two arguments: a **query** and a **callback** (which aliases the parameter you pass into it as the data that's returned from Domai.nr, so you can do whatever you want with it).
 
-	$ npm install domainr
+##### .search(query, callback)
 
+The `.search` method abstracts Domainr's own [search](http://domai.nr/api/docs/json#search-api) endpoint. The response will be a JSON object, like so:
 
-## Documentation
+	{
+	    "query": "domai.nr",
+	    "results": [{
+	      "domain": "domai.nr",
+	      "register_url": "http://domai.nr/domai.nr/register",
+	      "host": "",
+	      "path": "",
+	      "subdomain": "domai.nr",
+	      "availability": "taken"
+	    },
+	    {
+	      "domain": "dom.ai",
+	      "register_url": "http://domai.nr/dom.ai/register",
+	      "host": "",
+	      "path": "/nr",
+	      "subdomain": "dom.ai",
+	      "availability": "available"
+	    },
+	    {
+	      "domain": "doma.in",
+	      "register_url": "http://domai.nr/doma.in/register",
+	      "host": "",
+	      "path": "/r",
+	      "subdomain": "doma.in",
+	      "availability": "taken"
+	    },
+	    {
+	      "domain": "do.ma",
+	      "register_url": "http://domai.nr/do.ma/register",
+	      "host": "",
+	      "path": "/i.nr",
+	      "subdomain": "do.ma",
+	      "availability": "maybe"
+	    },
+	    {
+	      "domain": "d.om",
+	      "register_url": "http://domai.nr/d.om/register",
+	      "host": "",
+	      "path": "/ai.nr",
+	      "subdomain": "d.om",
+	      "availability": "unavailable"
+	    },
+	    {
+	      "domain": "do",
+	      "register_url": "http://domai.nr/do/register",
+	      "host": "",
+	      "path": "/mai.nr",
+	      "subdomain": "do",
+	      "availability": "tld"
+	    }]
+	}
 
-Like previously mentioned, this module comes with two methods available: `search`, and `info`. Both of them take two arguments: a **query** and a **callback** (which aliases the parameter you pass into it as the data that's returned from Domai.nr, so you can do whatever you want with it).
 
-##### .search(query, callback)
+To use `.search()`, it's very simple:
 
+```js
+var domainr = require('domainr')
 
-##### .info(query, callback)
+domainr.search("google.com", function(responseFromDomainr) {
+	// the responseFromDomainr is the JSON object mentioned above
+})
+```
+
+##### .info(query, callback)
+
+The `.info` method is called in the exact same way. It's an abstraction from Domainr's own [Info](http://domai.nr/api/docs/json#info-api) endpoint.
+
+The difference between `.info()` and `.search()` is the JSON response: it is information about the domain you pass in. See an example below:
+
+	{
+	  "domain": "domai.nr",
+	  "whois_url": "http://domai.nr/domai.nr/whois",
+	  "register_url": "http://domai.nr/domai.nr/register",
+	  "tld": {
+	    "domain": "nr",
+	    "domain_idna": "nr",
+	    "wikipedia_url": "http://wikipedia.org/wiki/.nr",
+	    "iana_url": "http://www.iana.org/domains/root/db/nr.html"
+	  },
+	  "registrars": [{
+	    "registrar": "cenpac.net.nr",
+	    "name": "CenpacNET",
+	    "register_url": "http://domai.nr/domai.nr/register/cenpac.net.nr"
+	  }],
+	  "host": "",
+	  "path": "",
+	  "www_url": "http://domai.nr/domai.nr/www",
+	  "query": "domai.nr",
+	  "subdomain": "domai.nr",
+	  "domain_idna": "domai.nr",
+	  "availability": "taken"
+	}
+
+To use `.info()`, it's very simple:
+
+```js
+var domainr = require('domainr')
+
+domainr.info("cnnr.me", function(responseFromDomainr) {
+	// the responseFromDomainr is the JSON object mentioned above
+})
+```
+
+
+## Examples
+
+I prefer making my express apps driven by an internal API. By that, I mean I like to set up back-end routes that my front-end routes can receive data from.
+
+I have made 2 simple apps using this package: [one using express](https://github.com/connormontgomery/Domainr-Node/tree/master/examples/express), and a [twitter bot](checkthisdomain-bot). You can see them both in the `/example` directory within this repo.
+
+
+## Shameless Plug
+
+I really like Domai.nr. If you do too, you may be interested in the [chrome extension](https://chrome.google.com/webstore/detail/ckimnhkhhfcedianojdljjgpgachccpf/reviews) or [twitter bot](checkthisdomain-bot) I wrote.

New alerts

No License Found

License

(Experimental) License information could not be found.

Found 1 instance in 1 package

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

156461

increased by2.22%

Number of low quality alerts

2

decreased by-33.33%

Number of lines in readme file

130

increased by465.22%

Worsened metrics

Number of low license alerts

1

increased byInfinity%

Lines of code

3059

decreased by-0.16%

No dependency changes