README 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. -------------------------------------------------------------------------------
  2. Dojo Storage
  3. -------------------------------------------------------------------------------
  4. Version X.XXX (does not have separate versioning -- versioned by release date)
  5. Last Release date: March 2008
  6. -------------------------------------------------------------------------------
  7. Project state:
  8. experimental
  9. -------------------------------------------------------------------------------
  10. Credits
  11. Brad Neuberg
  12. Alex Russell
  13. -------------------------------------------------------------------------------
  14. Project description
  15. dojox.storage provides a JavaScript abstraction for persistent storage
  16. as well as pluggable implementations which typically use native browser extensions
  17. (e.g. Flash player, Gears)
  18. -------------------------------------------------------------------------------
  19. Dependencies:
  20. FlashStorageProvider requires the Flash player
  21. GearsStorageProvider requires the Gears extension
  22. The various Air*StorageProviders require Adobe's AIR software
  23. The open source mtasc compiler (www.mtasc.org) is needed to build the
  24. ActionScript into SWF format. The SWF object is maintained within svn, so
  25. this step is only necessary if Storage.as is modified. A sample build script
  26. is provided (buildFlashStorage.sh)
  27. -------------------------------------------------------------------------------
  28. Documentation
  29. See http://manual.dojotoolkit.org/WikiHome/DojoDotBook/Book50 for the
  30. authoritative Dojo Storage docs.
  31. See dojox/storage/demos/helloworld.html for a simple Hello World example
  32. you can base your code off of.
  33. -------------------------------------------------------------------------------
  34. Installation instructions
  35. If you want to use Dojo Storage in a web browser:
  36. These installation instructions are to use Dojo Storage in a web browser; at
  37. runtime, Dojo Storage will autodetect and use the best available storage
  38. option. This includes:
  39. * Google Gears
  40. * HTML 5 Web Browsers (Firefox 2+)
  41. * Hidden Flash
  42. If you are using a release build (if you downloaded Dojo from the Dojo
  43. website then this is a release build -- if you checked it out from
  44. Subversion yourself then you will have to build things yourself), if you
  45. only want to grab just the files from Dojo to use Dojo Storage
  46. in the browser, take the following (but make sure to keep the directory
  47. layout the same, or else things won't work correctly!):
  48. * dojo/dojo.js
  49. * dojox/storage/storage-browser.js
  50. * dojox/storage/Storage.swf
  51. To help with testing and development and to make sure you have everything
  52. right, its also useful to grab the following files:
  53. * dojox/storage/README
  54. * dojox/storage/demos/helloworld.html
  55. If you want to use Dojo Storage with Adobe AIR:
  56. [TBD! Why don't you write this and contribute!]
  57. -------------------------------------------------------------------------------
  58. Additional Notes