Hey guys - I was trying to fix the readme file and came up with something like the below text, does this look right to all of you?
- Cassie +++ javascript/README (working copy) @@ -2,18 +2,23 @@ ========================================= 1) Try out the samples. - These provide examples of Gadget Container using gmodules.com for rendering. - Point your web browser at the following, substituting your Shindig code directory - for <shindig-dir>: - * file:///shindig-dir/javascript/container/sample1.html - * file:///shindig-dir/javascript/container/sample3.html + A) Set up your own Shindig Gadget Server. See its README for details. - Samples #2 and #4 need to be run in the context of a webserver for cookie and - container-gadget communication support. Start up your favorite browser and point - it at the .../shindig/javascript/container directory (here abbreviated <shindig-js-dir>): - * http://yourserver:yourport/shindig-js-dir/sample2.html - * http://yourserver:yourport/shindig-js-dir/sample4.html + B) Assuming your server is running on http://yourserver:yourport /gadgets/... + you can hit these html files in your favorite browser to see your local Shindig in action: + * http://yourserver:yourport/gadgets/files/container/sample1.html - basic container + * http://yourserver:yourport/gadgets/files/container/sample2.html - custom rendering + * http://yourserver:yourport/gadgets/files/container/sample3.html - custom layouts + * http://yourserver:yourport/gadgets/files/container/sample4.html - set pref + * http://yourserver:yourport/gadgets/files/container/sample5.html - set pref + * http://yourserver:yourport/gadgets/files/container/sample6.html - dynamic height + * http://yourserver:yourport/gadgets/files/container/sample7.html - set title + + These samples are very basic and aren't production-ready. Shindig will + include a more advanced container at a later date but it hasn't been + completed yet. + 2) Play around with the code. A) Create an HTML file including the following <head> boilerplate: @@ -43,13 +48,6 @@ C) Explore samples 2, 3, and 4 for examples using different LayoutManagers and supporting UserPrefs storage. -3) Try it with your own Gadget Server. - A) Set up your own Shindig Gadget Server. See its README for details. - - B) Assume your server is running on http://yourserver:yourport /gadgets/... - Before step 2.B.iv, call the following to point the Gadget at your server: - gadget.setServerBase('http://yourserver:yourport/gadgets/'); - 4) Run the opensocial sample container A) Set up your own Shindig Gadget Server. See its README for details. @@ -63,8 +61,4 @@ http://yourserver:yourport /gadgets/files/samplecontainer/getting-started.html -NOTE: In the short term, when rendering Gadgets using gmodules.com certain - functionality tied to inter-frame communication will not work, - such as SetPrefs and dynamically setting IFRAME height. - For more information, see http://incubator.apache.org/projects/shindig.html
