docs(readme): add README and images

Author: nivekcode

README.md

@@ -1,3 +1,32 @@
-# PrettyHtmlLog
+# @angular-extensions/pretty-html-log
 
-Work in progress
+This module allows you to pretty print the inner HTML
+of `ComponentFixtures`,
+`DebugElements`, `NativeElements` or even plain HTML `strings` to the console.
+
+## Getting started
+
+This module will only be used during development and can therefore
+be installed as a dev dependency.
+
+```
+npm i -D @angular-extension/pretty-html-log
+```
+
+This module is best used with Angular and Jest. Create a
+`setupJest.ts` file in your `src` directory and import
+`@angular-extension/pretty-html-log`.
+
+This import adds a `logNgHTML` method to your console. You can then
+use this method during tests to pretty print `ComponentFixtures`,
+`DebugElements`, `NativeElements` or even plain HTML `strings` .
+
+## Examples
+
+In your test you can simply write the following line.
+
+![logNgHTML](https://raw.githubusercontent.com/angular-extensions/pretty-html-log/master/doc/console.logNgHMTL.png)
+
+Which will print the following string to your console
+
+![logNgHTML](https://raw.githubusercontent.com/angular-extensions/pretty-html-log/master/doc/output.png)