diff --git a/package.json b/package.json index 4bc5086..6eb1a08 100644 --- a/package.json +++ b/package.json @@ -37,6 +37,17 @@ "pkg-up": "^3.1.0", "tacker": "^0.1.2" }, + "keywords": [ + "servexyz", + "npm", + "package.json", + "package", + "properties", + "get-pkg-prop", + "get package", + "get package property", + "get package properties" + ], "scripts": { "start": "npm run dev", "build": "webpack --mode production --display minimal", diff --git a/readme.md b/readme.md index 9b93911..c7295de 100644 --- a/readme.md +++ b/readme.md @@ -1,9 +1,11 @@ # get-pkg-prop + > Pass a key name, get a value from package.json ![travis CI build status](https://travis-ci.org/servexyz/get-pkg-prop.svg?branch=master) ## FAQ +
Why
getPkgProp(szProperty, szPathToPackageJSON) -
Where -* *szProperty* is the name of the property. -* *szPathToPackageJSON* is the path to either your package.json file or the directory which contains the package.json file. +- _szProperty_ is the name of the property. +- _szPathToPackageJSON_ is the path to either your package.json file or the directory which contains the package.json file. Why -* Specifying the path allows you to access the package of sub-modules or installed dependencies. +- Specifying the path allows you to access the package of sub-modules or installed dependencies.
getPkgProp(szProperty, oPackageJSON) -
Where -* *szProperty* is the name of the property. -* *oPackageJSON* is the JSON object which contains your package +- _szProperty_ is the name of the property. +- _oPackageJSON_ is the JSON object which contains your package Why -* I added this for mock testing inline package objects. -
-
+- I added this for mock testing inline package objects. +
+