Started writing the readme

AriaMinaei · Jan 25, 2014 · 25231bc · 25231bc
1 parent 5f943da
commit 25231bc
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,9 @@
+# Pretty Error
+
+A small tool to render node.js errors with less clutter, like this:
+
+![screenshot of Pretty Error](https://github.com/AriaMinaei/pretty-error/raw/master/docs/images/pretty-error-screenshot.png)
+
+... which is more readable compared to node's unformatted errors:
+
+![screenshot of normal errors](https://github.com/AriaMinaei/pretty-error/raw/master/docs/images/normal-error-screenshot.png)
diff --git a/docs/images/normal-error-screenshot.png b/docs/images/normal-error-screenshot.png
diff --git a/docs/images/pretty-error-screenshot.png b/docs/images/pretty-error-screenshot.png