Added basic README file
authorBrian Flowers <git-admn@bsflowers.net>
Thu, 22 Sep 2016 06:19:32 +0000 (02:19 -0400)
committerBrian Flowers <git-admn@bsflowers.net>
Thu, 22 Sep 2016 06:19:32 +0000 (02:19 -0400)
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..58745b7
--- /dev/null
+++ b/README
@@ -0,0 +1,22 @@
+bdsm-web
+A Slightly Cyberpunk project
+[git|www].slightlycyberpunk.com
+
+bdsm-web is a set of PHP scripts for displaying data from bdsm using HTML5 canvas charts.
+
+0) PREREQUISITES
+
+a) bdsm configured using the sqlite3 processor
+b) a remotely modern web browser
+
+1) INSTALLATION INSTRUCTIONS
+
+Install the Apache web browser with php5, sqlite3, and the associated Apache plugins.
+
+2) CONFIGURATION
+
+Visit the index.php page in your browser and navigate to the configuration page.
+
+Each reading found in the database can be renamed and configured to display on
+the graph or in the chart. If displaying on the graph, you can configure an alternative
+range (minimum and maximum values) and time period (how many seconds to display).
\ No newline at end of file