fix(docs): Update readme/license and provide homepage url for NPM distro

LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 Jack Pope
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,24 +1,86 @@
-# DocReducer
+# DocReducer [![Actions Status](https://github.com/jackpope/DocReducer/workflows/Build%2C%20test%2C%20and%20release/badge.svg?branch=master)](https://github.com/jackpope/DocReducer/actions)
 
-## Consolidate documentation across many Github repos with a VuePress site
+DocReducer is a Github documentation consolidation CLI tool. It pairs nicely with Vuepress doc sites, with helpers specifically for VuePress config, but could be used to conslidate documentation anywhere.
 
-### Usage:
+* DocReducer allows you to specify **repos across various orgs**, with various doc directories and custom README names.
+* DocReducer **helps resolve links** by transforming relative links that point outside of the doc directory to absolute links. It will also transform absolute links to other repos or docs into relative links so you can stay within the same documentation site whenever possible.
+* DocReducer generates missing README files in each documentation subdirectory to make sure doc site builders have reliable index pages.
+* DocReducer **provides helpers for Vuepress site configuration** to make building your new documentation site quick and easy.
 
-#### Using yarn
+## Using with a Vuepress site
 
-In a new project directory...
+### Setup and sync documents
 
 1. `yarn init`
 2. `yarn add vuepress doc-reducer`
 3. `touch doc-reducer.json`
 4. Add configuration to `doc-reducer.json` ([Example](./doc-reducer-example.json))
-5. `yarn doc-reducer`
-6. `yarn vuepress dev <doc desitination directory>`
+5. Make sure `GITHUB_TOKEN` and `GITHUB_USERNAME` env vars are available and have access to the repos added to `doc-reducer.json`
+6. `yarn doc-reducer`
+7. `yarn vuepress dev <doc desitination directory>`
 
-### Flow
+### Vuepress helpers
 
-- Fetch all files for directory on github repo
-- For each file
-  - Download file to disk
-  - Log file
-  - Add file to index README for the repo
+In addition to the document consolidation script, this package also exports helpers to configure your Vuepress site.
+
+#### navLinksGenerator
+
+Within your `.vuepress/config.js` file, use `navLinksGenerator` to add a Nav dropdown with an option for each repo you've synced by providing their base path.
+
+Example:
+
+```javascript
+const docReducer = require("doc-reducer");
+
+module.exports = {
+  title: "Site name",
+  themeConfig: {
+    nav: [
+      { text: "Home", link: "/" },
+      {
+        text: "Apps",
+        items: docReducer.navLinksGenerator("/apps")
+      }
+    ]
+  }
+};
+```
+
+#### sidebarLinksGenerator
+
+Within your `.vuepress/config.js` file, use `sidebarLinksGenerator` to add a sidebar with items for each repo and their headers. Provide the root location for your Vuepress content and the base path for the synced content.
+
+Example:
+
+```javascript
+const docReducer = require("doc-reducer");
+
+module.exports = {
+  title: "Site name",
+  themeConfig: {
+    sidebar: {
+      ...docReducer.sidebarLinksGenerator("docs", "apps"),
+      "/": ["apps/"]
+    }
+  }
+};
+```
+
+## Development
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
+
+You should have Node v12 and yarn installed on your system.
+
+```
+yarn install
+yarn test
+```
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/jackpope/DocReducer/tags).
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

package.json

@@ -2,6 +2,7 @@
   "name": "doc-reducer",
   "version": "1.0.1",
   "description": "Pull docs from multiple Github repos into a single VuePress site",
+  "homepage": "https://www.github.com/jackpope/DocReducer",
   "main": "src/index.js",
   "scripts": {
     "test": "./node_modules/jasmine/bin/jasmine.js",