fix(build): package lock and readme updates

Author: wyvern8

README.md

@@ -8,35 +8,67 @@
 [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?clear)](http://commitizen.github.io/cz-cli/)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-LaunchDarkly (https://launchdarkly.com/) provides SaaS based Feature Flag management at scale, with SDKs for all major Languages.
+LaunchDarkly (https://launchdarkly.com/) provides SaaS based Feature Flag management at scale, with SDKs for all major languages.
 
 This unofficial module provides NodeJs functions wrapping the LaunchDarkly API.  This is not the sdk for implementing flags in your app - it is the api to manage your account/flags.
 
 ## Why?
 There does not appear to be a project currently providing a simple interface to manage flags in LaunchDarkly via API in nodejs.  
 
 ## How?
-There is a swagger.yaml available to generate bindings (https://launchdarkly.github.io/ld-openapi/swagger.yaml).  Uses the swagger-js module to generate a client (https://github.com/swagger-api/swagger-js), and adds some extra features around logging and input validation.
+There is a swagger.yaml available to generate bindings (https://launchdarkly.github.io/ld-openapi/swagger.yaml), so we use the swagger-js module to generate a client (https://github.com/swagger-api/swagger-js), and add some extra features around logging and chaining of operations.
 
 ## Install
-`npm install launchdarkly-nodeutils --save`
+1. `npm install launchdarkly-nodeutils --save`
+2. Generate an access token with the permissions for the operations you will use. Please read: https://docs.launchdarkly.com/v2.0/docs/api-access-tokens
 
 ## Example usage
-Note that the api token is not the same as your sdk keys.  You need to generate this for your account in LaunchDarkly console.
+Please note that the api token is not the same as your sdk keys.  You need to generate this for your account in LaunchDarkly console as above, and set it as the LAUNCHDARKLY_API_TOKEN env var.
 
 ### commandline usage
+Command line support is primarily for debugging api calls.
 ```
 export LAUNCHDARKLY_API_TOKEN=<api-token>
-npm run api getFlags <myProjectId>
+
+// collect all flags for a project
+npm run api -- getFeatureFlags <myProjectId>
+
+// update or create a customRole with array of policies
+npm run api -- upsertCustomRole <customRoleKey> <customRoleName> '[{"resources":["proj/*"],"actions":["*"],"effect":"allow"}]'
 ```
 
 ### node app usage
+Assumes that you have set the LAUNCHDARKLY_API_TOKEN environment var.
 ```
 let ldUtils = await new LaunchDarklyUtils().create(process.env.LAUNCHDARKLY_API_TOKEN);
 
 // get flag state
 let flagEnabled = await ldUtils.getFeatureFlagState('myProject', 'feature-abc', 'dev');
 
 // update flag state to on=true
-await ldUtils.toggleFeatureFlag(proj'myProject', 'feature-def', 'dev', true);
+await ldUtils.toggleFeatureFlag('myProject', 'feature-def', 'dev', true);
 ```
+
+## commandline modes and parameters
+The command line modes and parameters map directly to the functions exposed for use in nodejs apps.
+
+### Feature flags
+
+| Mode | parameters |
+| ---- | ---------- |
+| getFeatureFlags | projectKey |
+| getFeatureFlag | projectKey, featureFlagKey, environmentKeyQuery |
+| getFeatureFlagState | projectKey, featureFlagKey, environmentKeyQuery |
+| toggleFeatureFlag | projectKey, featureFlagKey, environmentKeyQuery, enabled |
+
+### Custom roles
+
+| Mode | parameters |
+| ---- | ---------- |
+| getCustomRoles | none |
+| getCustomRole | customRoleKey |
+| createCustomRole | createCustomRole |
+| updateCustomRole | customRoleKey, customRoleName, customRolePolicyArray, customRoleDescription(optional) |
+| upsertCustomRole | customRoleKey, customRoleName, customRolePolicyArray, customRoleDescription(optional) |
+
+For details on role policy object structures, please see: https://docs.launchdarkly.com/docs/custom-roles