add install steps for scrub.sh

Author: cfarm

.env_SAMPLE

@@ -0,0 +1,2 @@
+export GHE_URL=fake.github.url
+echo 'Environment variable GHE_URL set'

README.md

@@ -1,60 +1,41 @@
-#### CFPB Open Source Project Template Instructions
+# Open Source Checklist
 
-1. Create a new project.
-2. Copy these files into the new project.
-3. Update the README, replacing the contents below as prescribed.
-4. Add any libraries, assets, or hard dependencies whose source code will be included
-   in the project's repository to the _Exceptions_ section in the [TERMS](TERMS.md).
-  - If no exceptions are needed, remove that section from TERMS.
-5. If working with an existing code base, answer the questions on the [open source checklist](opensource-checklist.md)
-6. Delete these instructions and everything up to the _Project Title_ from the README.
-7. Write some great software and tell people about it.
+Automating CFPB's [Open Source Checklist](https://github.com/cfpb/open-source-project-template/blob/master/opensource-checklist.md) for easy release of internal source code.
 
-> Keep the README fresh! It's the first thing people see and will make the initial impression.
+![](https://raw.githubusercontent.com/cfpb/open-source-project-template/master/screenshot.png)
 
-----
 
-# Project Title
+## Dependencies
 
-**Description**:  Put a meaningful, short, plain-language description of what
-this project is trying to accomplish and why it matters.
-Describe the problem(s) this project solves.
-Describe how this software can improve the lives of its audience.
+- [Node.js](https://nodejs.org/en/)
 
-Other things to include:
+## Installation
 
-  - **Technology stack**: Indicate the technological nature of the software, including primary programming language(s) and whether the software is intended as standalone or as a module in a framework or other ecosystem.
-  - **Status**:  Alpha, Beta, 1.1, etc. It's OK to write a sentence, too. The goal is to let interested people know where this project is at. This is also a good place to link to the [CHANGELOG](CHANGELOG.md).
-  - **Links to production or demo instances**
-  - Describe what sets this apart from related-projects. Linking to another doc or page is OK if this can't be expressed in a sentence or two.
+To use [scrub.sh](scrub.sh) to scrub GHE urls:
 
+### Add environment variable
 
-**Screenshot**: If the software has visual components, place a screenshot after the description; e.g.,
+1. Copy `[.env_SAMPLE](.env_SAMPLE)` to your project's root.
+1. Rename `.env_SAMPLE` to `.env`.
+1. Edit `fake.ghe.url` to point to the real GHE url (do not include `https://`).
+1. `cd` into your project repo root to activate the new environment variable. You should receive a warning and then a confirmation message: 
 
-![](https://raw.githubusercontent.com/cfpb/open-source-project-template/master/screenshot.png)
+![](https://raw.githubusercontent.com/cfpb/open-source-project-template/master/screenshot-env.png)
 
+## Configuration
 
-## Dependencies
-
-Describe any dependencies that must be installed for this software to work.
-This includes programming languages, databases or other storage mechanisms, build tools, frameworks, and so forth.
-If specific versions of other software are required, or known not to work, call that out.
+1. step 1
 
-## Installation
-
-Detailed instructions on how to install, configure, and get the project running.
-This should be frequently tested to ensure reliability. Alternatively, link to
-a separate [INSTALL](INSTALL.md) document.
+## Usage
 
-## Configuration
+1. In Terminal, from project root, run:
 
-If the software is configurable, describe it in detail, either here or in other documentation to which you link.
+```bash
+sh ./scrub.sh
+```
 
-## Usage
+![](https://raw.githubusercontent.com/cfpb/open-source-project-template/master/screenshot-scrub-success.png)
 
-Show users how to use the software.
-Be specific.
-Use appropriate formatting when showing code snippets.
 
 ## How to test the software
 
@@ -66,20 +47,11 @@ Document any known significant shortcomings with the software.
 
 ## Getting help
 
-Instruct users how to get help with this software; this might include links to an issue tracker, wiki, mailing list, etc.
-
-**Example**
-
 If you have questions, concerns, bug reports, etc, please file an issue in this repository's Issue Tracker.
 
 ## Getting involved
 
-This section should detail why people should get involved and describe key areas you are
-currently focusing on; e.g., trying to get feedback on features, fixing certain bugs, building
-important pieces, etc.
-
-General instructions on _how_ to contribute should be stated with a link to [CONTRIBUTING](CONTRIBUTING.md).
-
+This software currently has no tests which means it's certainly broken. Want to write bash scripts, node.js modules, break some git histories and probably some other things? [Contributions welcome!](CONTRIBUTING.md)
 
 ----