summaryrefslogtreecommitdiff
path: root/doc/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/README.txt')
-rw-r--r--doc/README.txt22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/README.txt b/doc/README.txt
new file mode 100644
index 0000000..9a29d6c
--- /dev/null
+++ b/doc/README.txt
@@ -0,0 +1,22 @@
+javascriptRRD
+=============
+
+javascriptRRD package contains a set of Javascript libraries
+that can be used for reading RRD archives from any Web browser.
+Mozilla, Internet Explorer and Safari hava been tested.
+
+Being Javascript an interpreted language, no compilation is needed.
+Just copy the files in the files located in the
+src/lib
+directory into a Web accessible location and use them.
+
+The
+src/examples/
+directory contain example Web pages that you can use as a template
+for writing your own Web Browser applications for accessing the
+RRD archives on your Web server.
+
+While the code itself tries to be self documenting, the
+doc/lib/
+directory contains more detailed information about the libraries.
+