add README file for Reports plugin with brief explanation of functionality
authorIan Barwick <barwick@gmail.com>
Sun, 3 Mar 2013 02:22:24 +0000 (11:22 +0900)
committerJehan-Guillaume (ioguix) de Rorthais <ioguix@free.fr>
Tue, 5 Mar 2013 16:15:13 +0000 (17:15 +0100)
plugins/Report/README [new file with mode: 0644]

diff --git a/plugins/Report/README b/plugins/Report/README
new file mode 100644 (file)
index 0000000..62e4140
--- /dev/null
@@ -0,0 +1,23 @@
+About the phpPgAdmin Report Plugin
+----------------------------------
+
+The Report Plugin is a sample plugin for phpPgAdmin's plugin architecture.
+
+It enables you to create and save ad-hoc SQL queries as reports which
+can be easily be executed from within phpPgAdmin.
+
+To save reports, this plugin requires the creation of a dedicated
+database containing a single table; see the INSTALL file and the
+sql/reports.sql file for details.
+
+Following installation, an icon for the Report plugin will appear 
+on the main overview page for each connected server. This provides
+an overview of all reports saved for the entire server, and enables
+executionm, editing and deletion of reports, as well as creation of 
+new reports from scratch.
+
+New reports can also be created while browsing table and view data,
+a "create report" link is provided at the bottom of each data page
+which pre-populates the report with the SQL used to generate the 
+data. 
+