fix function name and docs (#8)

README.md

@@ -51,14 +51,14 @@ const packageCompliant = require('package-compliant')
 const aPackageJson = require('./package.json')
 
 try {
-  packageCompliant.validatePackageJson(aPackageJson)
+  packageCompliant.validateSupportField(aPackageJson.support)
   // the package is valid
 } catch (err) {
   // the package has some errors
 }
 
 // or you can use callback:
-packageCompliant.validatePackageJson(aPackageJson, (err, valid) => {
+packageCompliant.validateSupportField(aPackageJson.support, (err, valid) => {
   if (err) {
     // there are some errors!!
   }

lib/index.js

@@ -2,4 +2,4 @@
 
 // this file is the main interface to use this package as a module
 
-module.exports.validatePackageJson = require('./support-validation')
+module.exports.validateSupportField = require('./support-validation')

lib/support-validation.js

@@ -9,10 +9,10 @@ const validate = ajv.compile(supportSchema)
 /**
  * Validate the package.json agains a JSON schema.
  * If a callback isn't provided, an error will be thrown if the json isn't valid.
- * @param {object} packageJson a package.json object
+ * @param {object} packageJson.support a package.json object
  * @param {function} cb an optional callback <Error[], boolean>
  */
-function validatePackageJson (packageJson, cb) {
+function validateSupportField (packageJson, cb) {
   const valid = validate(packageJson)
   if (cb) {
     cb(validate.errors, valid)
@@ -26,4 +26,4 @@ function validatePackageJson (packageJson, cb) {
   }
 }
 
-module.exports = validatePackageJson
+module.exports = validateSupportField

package.json

@@ -18,7 +18,12 @@
     "type": "git",
     "url": "git+https://github.com/Eomm/package-compliant.git"
   },
-  "keywords": [],
+  "keywords": [
+    "package",
+    "package-json",
+    "validation",
+    "support"
+  ],
   "author": "Manuel Spigolon <[email protected]> (https://github.com/Eomm)",
   "license": "MIT",
   "bugs": {
@@ -38,4 +43,4 @@
     "standard": "^12.0.1",
     "tap": "^12.6.3"
   }
-}
+}

test/public-api.test.js

@@ -4,8 +4,8 @@ const t = require('tap')
 const publicApi = require('../lib/index')
 const test = t.test
 
-test('validatePackageJson function', t => {
+test('validateSupportField function', t => {
   t.plan(1)
-  const func = publicApi.validatePackageJson
+  const func = publicApi.validateSupportField
   t.type(func, 'function')
 })