diff --git a/README.md b/README.md index 54e3530..6e62586 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,24 @@ A flamegraph generator for Postgres `EXPLAIN ANALYZE` output. + + + + +## Demo + +Try the demo [here](https://mgartner.github.io/pg_flame/flamegraph.html). + +## Installation + +Coming soon! + ## Usage -1. Generate a query plan in JSON by prefixing a SQL query with -`EXPLAIN (ANALYZE, BUFFERS, FORMAT JSON)`. Save the output to a file. +1. Generate a query plan in JSON by prefixing a SQL query with `EXPLAIN + (ANALYZE, BUFFERS, FORMAT JSON)`. Save the output to a file. Example query + plan JSON can be found + [here](https://mgartner.github.io/pg_flame/plan.json). _Example:_