diff --git a/README.md b/README.md index b5c3543..68647af 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,12 @@ # Hyperion +
+ +
**Note:** An overview of our security policies is available [here](/SECURITY.md). *Please read this document before using our app. Using our app constitues acknowledgment of the disclaimers presented in that document at the time of sign-up.* + + # Table of Contents > - [Description]() @@ -14,11 +19,30 @@ # Description -Dynamic forecasting of PostgreSQL database performance. Problem. Solution. Why we built it. +Hyperion: A PostgreSQL analytic tool to test and compare actual dynamic query runtimes with query runtimes calculated by PostgreSQL's EXPLAIN ANALYZE profiling tool. # Features -So many great features to come! +> - Overview +> - Databases + >> - On the Database page, users can connect to their databases by either providing the database URI or manually providing connection details (host, port, database name, and user credentials) +
+ +
+ +> - Queries + >> - On the Queries page, users can select a database, input queries, and optional parameter placeholders. +
+ +
+ +> - Run Tests + >> - On the Run Test page, users can select a database, and query. The run test function will then display the actual query runtime measured by the PostgreSQL server’s CPU clock time as well as query runtime provided via the explain analyze command and associated summary statistics (min, max, median, sd, q1,q3). +
+ +
+ + # How to Use @@ -26,7 +50,6 @@ A hosted version is available [at this link](#). If you prefer to run it locally, you can also fork and clone the repository and run the production version locally using `node server/server.js` at the root directory. -A step-by-step tutorial is also available [here](/TUTORIAL.md). # Technologies @@ -34,7 +57,9 @@ A step-by-step tutorial is also available [here](/TUTORIAL.md). - React - Redux - PostgreSQL -- etc... +- Typescript +- Material UI +- Plotly.js # Dependencies diff --git a/TUTORIAL.md b/TUTORIAL.md deleted file mode 100644 index 3d8ba28..0000000 --- a/TUTORIAL.md +++ /dev/null @@ -1,5 +0,0 @@ -# Hyperion Tutorial - -# Table of Contents - -# Getting Started \ No newline at end of file diff --git a/assets/RunningTest.gif b/assets/RunningTest.gif new file mode 100644 index 0000000..99b9a51 Binary files /dev/null and b/assets/RunningTest.gif differ diff --git a/assets/addingdatabase.gif b/assets/addingdatabase.gif new file mode 100644 index 0000000..6110e40 Binary files /dev/null and b/assets/addingdatabase.gif differ diff --git a/assets/addingquery.gif b/assets/addingquery.gif new file mode 100644 index 0000000..f0caa27 Binary files /dev/null and b/assets/addingquery.gif differ diff --git a/assets/logo.jpg b/assets/logo.jpg new file mode 100644 index 0000000..fba9634 Binary files /dev/null and b/assets/logo.jpg differ diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 0000000..3070356 Binary files /dev/null and b/assets/logo.png differ