diff --git a/README.md b/README.md index 01930ca..f8109bf 100644 --- a/README.md +++ b/README.md @@ -258,7 +258,7 @@ The report can be converted, for instance, into a HTML table as below: ![dsnet report table](https://raw.githubusercontent.com/naggie/dsnet/master/etc/report.png) See -[etc/README.md](https://github.com/naggie/dsnet/blob/master/etc/dsnetreport.html) +[etc/README.md](https://github.com/naggie/dsnet/blob/master/report_rendering/README.md) for hugo and PHP code for rendering a similar table. # FAQ diff --git a/etc/README.md b/etc/README.md deleted file mode 100644 index bef13b7..0000000 --- a/etc/README.md +++ /dev/null @@ -1,2 +0,0 @@ -* `dsnetreport.php`: A php file to render a report. -* `dsnetreport.html`: A hugo shortcode for rendering a report. See https://github.com/naggie/dsnet/issues/4#issuecomment-632928158 for background. diff --git a/report_rendering/README.md b/report_rendering/README.md new file mode 100644 index 0000000..5239df1 --- /dev/null +++ b/report_rendering/README.md @@ -0,0 +1,14 @@ +This directory contains scripts and templates that can be used to render +`/var/lib/dsnetreport.json`. They are useful for integrating a peer overview +into an existing website or web application. + +Most are contributions from other users. If you have a useful addition, please +do a PR. + + +* `dsnetreport.php`: A php file to render a report. +* `dsnetreport.html`: A hugo shortcode for rendering a report. See https://github.com/naggie/dsnet/issues/4#issuecomment-632928158 for background. Courtesy of [@Write](https://github.com/Write) + +Most look something like this: + +![dsnet report table](https://raw.githubusercontent.com/naggie/dsnet/master/etc/report.png) diff --git a/etc/dsnetreport.html b/report_rendering/dsnetreport.html similarity index 100% rename from etc/dsnetreport.html rename to report_rendering/dsnetreport.html diff --git a/etc/dsnetreport.php b/report_rendering/dsnetreport.php similarity index 100% rename from etc/dsnetreport.php rename to report_rendering/dsnetreport.php