Better readme and minor changes in API interface

Author: faheem556

.codeclimate.yml

@@ -1,10 +1,12 @@
 engines:
   eslint:
     enabled: true
-
+    channel: "eslint-2"
+    config:
+      config: .eslintrc.json
 ratings:
   paths:
-    - "lib/**"
-    - "spec/**"
-
-#exclude_paths:
+  - bin/**/*.js
+  - lib/**/*.js
+exclude_paths:
+- "node_modules/**"

.eslintrc.json

@@ -120,6 +120,17 @@
     "space-in-parens": ["error", "never"],
     "space-infix-ops": "error",
     "space-unary-ops": ["error", { "words": true, "nonwords": false }],
-    "unicode-bom": ["error", "never"]
+    "unicode-bom": ["error", "never"],
+    "curly": "error",
+    "complexity": "error",
+    "block-spacing": "error"
+  },
+  "globals": {
+    "AnalysisView": true,
+    "PollingView": true,
+    "Prism": true,
+    "Spinner": true,
+    "Timer": true,
+    "moment": true
   }
 }

README.md

@@ -1,10 +1,48 @@
 # samwise
 
-[![Coverage Status](https://coveralls.io/repos/github/NuAxis/samwise/badge.svg)](https://coveralls.io/github/NuAxis/samwise)
+[![Build Status](https://travis-ci.org/NuAxis/samwise.svg?branch=develop)](https://travis-ci.org/NuAxis/samwise)
 [![Code Climate](https://codeclimate.com/github/NuAxis/samwise/badges/gpa.svg)](https://codeclimate.com/github/NuAxis/samwise)
 [![Test Coverage](https://codeclimate.com/github/NuAxis/samwise/badges/coverage.svg)](https://codeclimate.com/github/NuAxis/samwise/coverage)
-[![Issue Count](https://codeclimate.com/github/NuAxis/samwise/badges/issue_count.svg)](https://codeclimate.com/github/NuAxis/samwise)
 
 A simple SAM API wrapper inspired by https://github.com/18F/samwise
 
-```npm install samwise```
+```npm install samwisejs```
+
+## Interfaces
+```javascript
+var Samwise = require('samwisejs');
+
+Samwise.Api.searchEntities(API_KEY, TERMS, function(error, entities) {});
+Samwise.Api.getRegistration(API_KEY, DUNS, function(error, registration) {});
+Samwise.Api.getGovBusinessPointOfContact(API_KEY, DUNS, function(error, contact) {});
+```
+
+## Example
+
+```javascript
+var Samwise = require('samwisejs');
+var DUNS = '1234567'; // 7,8,9 and 13 digit duns with/without dashes are accepted
+var DG_API_KEY = 'DEMO_KEY'; // get at https://api.data.gov/signup/
+var searchTerms = ''; // http://gsa.github.io/sam_api/sam/search.html
+
+var printResult = function(error, entities) {
+  if(!error && entities.length > 0) {
+    for(var i = 0; i < entities.length; i++) {
+      console.log(entities[i].legalBusinessName);
+    }
+  }
+}
+```
+
+
+## Build
+
+``` gulp ```
+
+OR
+
+```npm test```
+
+## Browserify
+
+```npm run browserify```

lib/api.js

@@ -17,7 +17,7 @@ var Api = {
     return this.pathV1 + '?qterms=' + qterms + '&api_key=' + apiKey;
   },
 
-  getRegistrations: function(apiKey, qterms, callback) {
+  searchEntities: function(apiKey, qterms, callback) {
     /* istanbul ignore next */
     callback = callback || function() {};
     if (!apiKey || !qterms) {

spec/samwise/api_spec.js

@@ -24,22 +24,22 @@ describe('Duns', function() {
     });
   });
 
-  describe('#getRegistrations', function() {
+  describe('#searchEntities', function() {
     it('should throw error if api key is not passed', function() {
       expect(function() {
-        Samwise.Api.getRegistrations();
+        Samwise.Api.searchEntities();
       }).toThrowError(Samwise.Errors.API_KEY_OR_QTERMS_MISSING);
     });
 
     it('should return results array if correct params passed', function() {
       nock(Samwise.Api.baseUrl)
         .get(Samwise.Api.getSamV1Path(API_KEY, GOOD_QTERMS))
-        .replyWithFile(200, __dirname + '/replies/registrations.json');
+        .replyWithFile(200, __dirname + '/replies/entities.json');
 
-        Samwise.Api.getRegistrations(API_KEY, GOOD_QTERMS, function(error, registrations) {
+        Samwise.Api.searchEntities(API_KEY, GOOD_QTERMS, function(error, entities) {
           expect(error).toBeNull();
-          expect(registrations).not.toBeNull();
-          expect(registrations.length).toBe(10);
+          expect(entities).not.toBeNull();
+          expect(entities.length).toBe(10);
         });
     });
   });