Alpha 2 bugs and things

README.md

@@ -1,22 +1,43 @@
-# Command Line Interface (CLI) for the mediumroast.io
-Inclued within this SDK is a CLI for users who are more inclined to use that tool for interacting with the system.  These tools will be added and updated to over time as the system evolves. More information on the CLI is available in the [CLI README](./cli/README.md).
+# Welcome to Open Source Mediumroast for GitHub.
+Products organizations must build robust product plans from competitive and customer interactions everyone can see, use, and reference. Therefore, Mediumroast for GitHub intends to help Products oranizations construct an active interactions repository close to the action of development and issue management in GitHub.      
 
+# Installation and configuration
+Mediumroast for GitHub includes a [GitHub Application](https://github.com/apps/mediumroast-for-github), a [Command Line Interface](./cli/README.md), and a Software Development Kit.  The following 
 
+## Preinstallation Requirements
+1. A GitHub organization, please 
+2. Permissions in your GitHub organization to install a GitHub application.
+3. Access to a command line terminal on Linux or MacOS.
+4. [Node.js installed](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-installer-to-install-nodejs-and-npm), ideally globally for all users.
+5. [NPM installed](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm#using-a-node-installer-to-install-nodejs-and-npm), ideally globally for all users.
 
+## Step 1 - Install the Mediumroast for GitHub Application
 
-# Installation and Configuration Steps via NPM
-This package is available for installation from NPM as *mediumroast_js* and can be installed and removed via the `npm` command. Several approaches to installation are documented below.
+## Step 2 - Install mediumroast_js via NPM
+This package [mediumroast_js](https://www.npmjs.com/package/mediumroast_js) can be installed and removed via `npm`, several ways to install follow.
 
-## Installation for Linux, UNIX and MacOS
-Assuming you have installed both *node.js* and *npm* the following installation processes are possible.
+### Installation for Linux, UNIX and MacOS
+Assuming the preinstallation requirements, installation of *node.js* and *npm*, are met please one one of the following.
 1. Global installation for all users: `sudo npm i -g mediumroast_js`
 2. Local installation for a developer or single user: `npm i mediumroast_js`
 
-## Installation for WinOS
+### Installation for WinOS
 Coming soon.
 
+## Step 3 - Setup the Mediumroast for GitHUB CLI
+Before you can use the Mediumroast for GitHub CLI the environment must be setup.  With the CLI installed please run `mrcli setup` to start the setup process, note there's a video of the setup process in [CLI README](./cli/README.md).
+
+# What's provided
+Running `mrcli setup` creates a repository in your oganization called `<organization_name>_discovery` for all interactions and objects, creates two intitial companies, and installs two GitHub Actions to control the number of branches and provide some basic out of the box reporting -- see example screenshot below.
+
+## Warning
+Since the repository is a GitHub repository under the covers you can interact with it as a normal repository, but **doing so is not recommended**. If you interact with the repository in regular ways this could result in Mediumroast for GitHub becoming unoperable.  There are cases where it may become necessary to directly work with the repository, but that should be rare.
+
+## Example screenshot of in repositor companiesrReport
+<img width="1001" alt="companies" src="https://github.com/mediumroast/mediumroast_js/assets/10818650/23fbd53f-dbfe-4106-a18d-5d13e0b5ce2b">
+
 # Issues
-If you detect a problem in the code please open an [issue](https://github.com/mediumroast/mediumroast_js/issues) and we will work with you to resolve.
+If you detect a problem or want to suggest an improvement open an [issue](https://github.com/mediumroast/mediumroast_js/issues) and we will work with you to resolve or respond.
 
 
 

cli/tutorials.json

@@ -0,0 +1,11 @@
+{
+    "README": {
+        "title": "Administrative Subcommands"
+    },
+    "Interaction": {
+        "title": "Interaction Subcommand"
+    },
+    "Company": {
+        "title": "Company Subcommand"
+    }
+}