Merge pull request cfpb#8 from marcesher/master

Update README.md

Author: virtix

README.md

@@ -17,10 +17,13 @@
 # Project Title
 
 **Description**:  Put a meaningful, short, plain-language description of what
-this project is trying to accomplish and why it matters.
+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.
 
 Other things to include:
 
+  - **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.
@@ -31,12 +34,43 @@ Other things to include:
 ![](https://raw.githubusercontent.com/cfpb/open-source-project-template/master/screenshot.png)
 
 
-## How to get this running or how to use it
+## 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 or known not to work, call that out.
+
+## Installation
 
 Detailed instructions on how to install, configure, and get the project running.
 This should be frequently tested to ensure reliability. Alternatively, a link to
 another page is fine, but it's important that this works.
 
+## Configuration
+
+If the software is configurable, describe it in detail, either here or in other documentation to which you link.
+
+## Usage
+
+Show users how to use the software. 
+Be specific. 
+Use appropriate formatting when showing code snippets.
+
+## How to test the software
+
+If the software includes automated tests, detail how to run those tests.
+
+## Known issues
+
+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