Merge pull request #138 from codecov/update-readme-pre-oss

Update README.md

Author: eliatcodecov

README.md

@@ -2,9 +2,11 @@
 
 [![codecov](https://codecov.io/gh/codecov/codecov-cli/branch/master/graph/badge.svg?token=jN0CICuA6Z)](https://codecov.io/gh/codecov/codecov-cli)
 
-CodecovCLI is a new way for users to interact with Codecov directly from the user’s terminal or CI platform. Many Codecov features that require the user’s interference can be done via the codecovCLI. It saves commits, creates reports, uploads coverage and has many more amazing features.
+CodecovCLI is a new way for users to interact with Codecov directly from the user’s terminal or CI platform. Many Codecov features that require the user’s interference can be done via the codecovCLI. It saves commits, creates reports, uploads coverage and has many more features.
 
 - [Installing](#installing)
+  - [Using PIP](#using-pip)
+  - [As a Binary](#as-a-binary)
 - [Usage](#usage)
 - [Codecov-cli Commands](#codecov-cli-commands)
   - [create-commit](#create-commit)
@@ -14,28 +16,33 @@ CodecovCLI is a new way for users to interact with Codecov directly from the use
   - [get-report-results](#get-report-results)
   - [pr-base-picking](#pr-base-picking)
 - [How to upload to Codecov](#how-to-upload-to-codecov)
-- [How to Local upload](#how-to-local-upload)
-- [Plugin System](#plugin-system)
+- [How to Use Local Upload](#how-to-use-local-upload)
+- [Work in Progress Features](#work-in-progress-features)
+  - [Plugin System](#plugin-system)
+  - [Static Analysis](#static-analysis)
 - [Contributions](#contributions)
   - [Requirements](#requirements)
   - [Guidelines](#guidelines)
 - [Releases](#releases)
 
 # Installing
 
-To use codecov-cli in your local machine, or your CI workflows, you need to install it
+## Using PIP
+To use codecov-cli in your local machine, or your CI workflows, you need to install it:
 
 `pip install codecov-cli`
 
-The above command will download the latest version of Codecov-cli. If you wish to use a specific version, releases can be viewed [here](). 
-You can also find Codecovcli [here](https://cli.codecov.io/) or in the [Github releases](https://github.com/codecov/codecov-cli/releases) where you can download the binary distributable files. 
+The above command will download the latest version of Codecov-cli. If you wish to use a specific version, releases can be viewed [here](https://pypi.org/project/codecov-cli/#history). 
+
+## As a Binary
+If you would like to use the CLI in an environment that does not have access to Python / PIP, you can install the CLI as a compiled binary. Linux and macOS releases can be found [here](https://cli.codecov.io/), along with SHASUMs and signatures for each released version. Binary releases are also available via [Github releases](https://github.com/codecov/codecov-cli/releases) on this repository. 
 
 # Usage 
 If the installation is successful, running `codecovcli --help` will output the available commands along with the different general options that can be used with them. 
 ```
 Usage: codecovcli [OPTIONS] COMMAND [ARGS]...
 ```
-Codecov-cli supports inputs from the user. These inputs, along with their descriptions and usage contexts, are listed in the table below:
+Codecov-cli supports user input. These inputs, along with their descriptions and usage contexts, are listed in the table below:
 
 | Input  | Description | Usage |
 | :---:     |     :---:   |    :---:   |
@@ -48,7 +55,7 @@ Codecov-cli supports inputs from the user. These inputs, along with their descri
 # Codecov-cli Commands
 | Command  | Description | 
 | :---:     |     :---:   |    
-| `create-commit` | Saves the commit's metadata in codecov, only need to do it once for a commit 
+| `create-commit` | Saves the commit's metadata in codecov, it's only necessry to run this once per commit 
 | `create-report` | Creates an empty report in codecov with initial data e.g. report name, report's commit 
 | `do-upload` | Searches for and uploads coverage data to codecov 
 | `create-report-results` | Used for local upload. It tells codecov that you finished local uploading and want it to calculate the results for you to get them locally.
@@ -150,8 +157,9 @@ Codecov-cli supports inputs from the user. These inputs, along with their descri
 |--service | Git provider. Options: github, gitlab, bitbucket, github_enterprise, gitlab_enterprise, bitbucket_server | Optional
 |--help | Shows usage, and command options
 
-# How to upload to Codecov
-In your CI workflow, you need to add these commands: 
+# How to Upload to Codecov
+If desired, the CLI can be used as a replacement for our [NodeJS Binary Uploader](https://github.com/codecov/uploader). To use the CLI to upload from your CI workflow, you need to add these commands: 
+
 ```
 pip install codecovcli
 codecovcli create-commit
@@ -160,8 +168,12 @@ codecovcli do-upload
 ```
 You can customize the commands with the options aligned with each command. 
 
-# How to Local upload: 
-If you CI workflow takes too much time to run, and you have to wait for it to finish to know the coverage results, you can make your changes locally, make a PR and then run these commands:  
+# How to Use Local Upload
+
+The CLI also supports "dry run" local uploading. This is useful if you prefer to see Codecov status checks and coverage reporting locally, in your terminal, as opposed to opening a PR and waiting for your full CI to run. Local uploads do not interfere with regular uploads made from your CI for any given commit / Pull Request. 
+
+Local Upload is accomplished as follows:
+
 ```
 pip install codecovcli
 codecovcli create-commit
@@ -173,21 +185,27 @@ codecovcli get-report-results --code <CODE>
 
 Codecov will calculate the coverage results, and return them in your terminal, telling you whether your PR will fail or pass the coverage check.
 
+Note: In order for Local Upload to work, it must be used against a commit on the origin repository. Local Upload does not work for arbitrary diffs or uncommitted changes on your local machine. 
+
+# Work in Progress Features
+
+The following features are somewhat implemented in code, but are not yet meant for use. These features will be documented once they are fully implemented in the CLI. 
 
-# Plugin System
+## Plugin System
 
-In some of the commands, there is a plugin system. For most cases, one might find that changing them is not really needed. But in some cases, have some custom logic run would be beneficial
+To provide extensibility to some of its commands, the CLI makes use of a plugin system. For most cases, the default commands are sufficient. But in some cases, having some custom logic specific to your use case can be beneficial. Note that full documentation of the plugin system is pending, as the feature is still heavily a work in progress.
 
+## Static Analysis
 
-WIP
+The CLI can perform basic static analysis on Python code today. This static analysis is meant to power more future looking Codecov features and, as such, is not required or in active use today. As more functionality dependent on static analysis becomes available for use, we will document static analysis in detail here. 
 
 # Contributions
 
 ## Requirements
 
-To start, most of this package is a normal Python package. The main different thing is the static analysis tool that uses both git submodules and c code
+Most of this package is a very conventional Python package. The main difference is the static the CLI's analysis module uses both git submodules and C code
 
-Before installing, one should pull the submodules with
+Before installing, one should pull the submodules with:
 
 ```
 git submodule update --init
@@ -198,20 +216,20 @@ pip install -r requirements.txt
 python setup.py develop
 ```
 
-The c code shouldn't require anything in most places, but it might ask you to install compilers and stuff. Most of the times you can find the instructions online given the error message
+The C code shouldn't require anything additional setup to get running, but depending on your enviroment, you may be prompted to install compilers and supporting tools. If errors are generating during installation, it is likely due to missing dependencies / tools required of the C code. In many cases, resulting error messages should be clear enough to determine what is missing and how to install it, but common errors will be collected here as they are encountered.
 
 ## Guidelines
 
-There are a few guidelines when developing in this systems. We have a few notable folders:
+There are a few guidelines when developing in this systems. Some notable folders:
 
-1. `commands` - It's the folder that interacts with the caller. This is where the commands themselves should live. They are not meant to do heavy lifting. They only do wiring, which is mostly parsing the input parameters
-2. `services` - It's where the heavy logic lives. It's mostly organizaed by which command needs them.
-3. `helpers` - This is meant for logic that is probably useful accross different commands. For example, logging helpers, or the logic the searches folders
+1. `commands` - It's the folder that interacts with the caller. This is where the commands themselves should reside. These commands are not meant to do heavy lifting. They only do wiring, which is mostly parsing the input parameters. 
+2. `services` - It's where the heavy logic resides. It's mostly organizaed by which command needs them. Commands should generally be thin wrappers around these services.
+3. `helpers` - This is meant for logic that is useful accross different commands. For example, logging helpers, or the logic the searches folders.
 
 # Releases
 
 The standard way to making a new release is the following:
-1)  Open a PR that increases the version number in setup.py. As a rule of thumb, just add one to the micro version (number most to the right).
+1)  Open a PR that increases the version number in setup.py. As a rule of thumb, just add one to the micro/patch version (e.g., v0.1.6 -> v0.1.7).
 
 2) Get the up-to-date master branch locally and run the `tag.release` command from the Makefile.
 
@@ -221,4 +239,4 @@ The version tag must match the regex defined on the Makefile (`tag_regex := ^v([
 
 >**Note**: \
 >Releases with `test` word in them are created as `draft`. \
->Releases with `beta` work in them are created as `pre-release`.
+>Releases with `beta` word in them are created as `pre-release`.