summaryrefslogtreecommitdiff
path: root/js/dojo/dojox/store/README
diff options
context:
space:
mode:
Diffstat (limited to 'js/dojo/dojox/store/README')
-rw-r--r--js/dojo/dojox/store/README47
1 files changed, 47 insertions, 0 deletions
diff --git a/js/dojo/dojox/store/README b/js/dojo/dojox/store/README
new file mode 100644
index 0000000..123a4e7
--- /dev/null
+++ b/js/dojo/dojox/store/README
@@ -0,0 +1,47 @@
+-------------------------------------------------------------------------------
+DojoX Stores (data)
+-------------------------------------------------------------------------------
+Version 1.000
+Release date: 03/04/2011
+-------------------------------------------------------------------------------
+Project state:
+LightstreamerStore: beta
+-------------------------------------------------------------------------------
+[ ] l18n support?
+[ ] a11y support?
+-------------------------------------------------------------------------------
+Credits
+LightstreamerStore: Kris Zyp (kris@sitepen.com)
+ Tom Trenka (ttrenka@gmail.com)
+ Lightstreamer (http://lightstreamer.com)
+-------------------------------------------------------------------------------
+Project description
+
+DojoX Stores is intended to serve as a place where experimental stores based
+on the dojo.store APIs can live. At the time of writing, only the
+LightstreamerStore is available, but more stores may be added in the future.
+
+The LightstreamerStore is a lightweight object store that is intended to be
+used with the Lightstreamer Web Client and the Lightstreamer Server. It allows
+one to connect to a Lightstreamer server and get continuous updates (depending
+on the data adapter and mode used). Because it requires the Lightstreamer
+server, unit tests are not functional here; there is a demonstration of it in
+action (URL to be determined).
+-------------------------------------------------------------------------------
+Dependencies:
+
+The main dependency of the LightstreamerStore is dojo/store/util/QueryResults.
+-------------------------------------------------------------------------------
+Documentation
+
+LightstreamerStore: inline API documentation is included.
+-------------------------------------------------------------------------------
+Installation instructions
+
+Download the Dojo distribution and set up your Lightstreamer instance, and go!
+-------------------------------------------------------------------------------
+Additional Notes
+
+LightstreamerStore: The main place to hook your code to is to define an "observe"
+ function on the results from a query; this function will be passed a JSON-like
+ object, with which you can do anything you want.