aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 21 insertions, 1 deletions
diff --git a/README.md b/README.md
index d81c36e..d564fcc 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,21 @@
-# Postgres Explain Visualizer (PEV)
+# Postgres Explain Visualizer (pev)
+
+Postgres Explain Visualizer (dev) is designed to make [EXPLAIN](http://www.postgresql.org/docs/current/static/sql-explain.html) output easier to grok. It creates a graphical representation of the plan.
+
+Pev is heavily influenced by the excellent [explain.depesz.com](http://explain.depesz.com/).
+
+Pev is written in [angular 2](https://angular.io/) with TypeScript. It requires [npm](https://www.npmjs.com/), [gulp](), [tsd](http://definitelytyped.org/tsd/), and [compass](http://compass-style.org/).
+
+## Installation
+
+```
+npm install
+npm start
+```
+
+You may also need to install tsd and compass:
+
+```
+npm install tsd -g
+gem install compass
+``` \ No newline at end of file