Merge branch 'master' of https://github.com/socketstream/socketstream

Author: marocchino

HISTORY.md

@@ -1,3 +1,28 @@
+0.3.0 / 2012-XX-XX
+==================
+
+Not yet released. These are the changes so far...
+
+
+##### Improvements for Production Hosting
+
+* IMPORTANT: `ss.client.packAssets()` now tries to use existing pre-packed assets if present
+* If no assets are found, or you pass the env var `SS_PACK=1`, assets will always be (re)packed
+* Static assets now have a cache expiry header of 30 days by default. Configurable with `ss.client.set({static: {maxAge: newValue}})` as before
+* NEW: CDN paths can now be functions. E.g. `ss.client.packAssets({cdn: {js: function(file){ return "http://mycdn.com" + file.path; } }})` 
+
+
+##### Other
+
+* Updated to work on Node 0.8 [Discuss any issues here](https://github.com/socketstream/socketstream/issues/250)
+* Live Reload now uses `chokidar` for better performance on Windows and when creating new files. Big thanks to CyberWalrus
+* Updated many package dependencies
+* Added documentation in Korean (thanks EngForDev)
+* Enable proper handling of question marks and params when routing HTTP requests (thanks matthiasg)
+* In newly generated projects `ss.define.client()` now lists client libs explicitly to avoid confusion over load order
+* Updated bundled jQuery to 1.7.2
+
+
 0.3 RC2 / 2012-05-04
 ====================
 
@@ -10,7 +35,6 @@
 * Minor refactoring
 * Updated README with video link
 
-Note: SocketStream 0.3.0 will be officially launched later in May, along with example apps, screencasts, more documentation and improvements to [www.socketstream.org](http://www.socketstream.org). Read announcement [here](https://groups.google.com/forum/?fromgroups#!topic/socketstream/Y6OIOrJRX7w).
 
 
 0.3 RC1 / 2012-04-22
@@ -36,8 +60,6 @@ Note: SocketStream 0.3.0 will be officially launched later in May, along with ex
 * Removed code to check for previous versions of 0.3
 * Updated `package.json` with names of significant/regular contributors. Thanks guys!
 
-Note: SocketStream 0.3.0 will be officially launched in May, along with example apps, screencasts, more documentation and improvements to [www.socketstream.org](http://www.socketstream.org). Read announcement [here](https://groups.google.com/forum/?fromgroups#!topic/socketstream/Y6OIOrJRX7w).
-
 
 
 0.3 beta2 / 2012-04-10

INSTALL.md

@@ -8,13 +8,9 @@ Note: These instructions will be changed once the first 0.3 package is published
 
 ### Mac OS X installation (tested on OS X Lion)
 
-    # install XCode, required for compiling software
-    
-    http://itunes.apple.com/gb/app/xcode/id422352214?mt=12
-    
     # install Node.js
 
-    Download latest stable (0.6.x) version from http://nodejs.org/#download
+    Download latest stable (0.8.x) `.dmg` from http://nodejs.org/#download
 
     # install SocketStream (latest from Github master)
 
@@ -40,12 +36,12 @@ Here is an example that shows how to install SocketStream and it's dependencies
 
     # install Node.js
 
-    Download latest stable (0.6.x) version from http://nodejs.org/#download
+    Download latest stable (0.8.x) version from http://nodejs.org/#download
 
-    E.g. for Node 0.6.7
+    E.g. for Node 0.8.0
 
-    tar zxvf node-v0.6.7.tar.gz
-    cd node-v0.6.7
+    tar zxvf node-v0.8.0.tar.gz
+    cd node-v0.8.0
     ./configure
     make # this will take a couple of minutes
     sudo make install
@@ -80,3 +76,4 @@ Here is an example that shows how to install SocketStream and it's dependencies
     cd test
     npm install
     npm install ..\socketstream    
+

README.md

@@ -10,9 +10,7 @@ Twitter: [@socketstream](http://twitter.com/#!/socketstream)
 Google Group: http://groups.google.com/group/socketstream  
 IRC channel: [#socketstream](http://webchat.freenode.net/?channels=socketstream) on freenode
 
-Take a tour of all the new features at http://www.socketstream.org/tour
-
-Note: I will be talking about SocketStream 0.3 at [LNUG](http://lnug.org) on Wednesday 23rd May.
+Take a tour of all the new features at http://www.socketstream.org/tour and watch the [introductory video](http://vimeo.com/43027679) (recorded May 2012).
 
 
 ### Introduction
@@ -43,7 +41,7 @@ While it is still early days, our end goal is to ensure SocketStream can be used
 
 SocketStream is in full-time development, rapidly progressing thanks to frequent contributions from a [growing community](http://groups.google.com/group/socketstream) of developers.
 
-SocketStream 0.3.0 will be officially launched in May, along with example apps, screencasts, more documentation and improvements to [www.socketstream.org](http://www.socketstream.org). Read announcement [here](https://groups.google.com/forum/?fromgroups#!topic/socketstream/Y6OIOrJRX7w).
+SocketStream 0.3.0 will be launched shortly, along with example apps, screencasts, more documentation and improvements to [www.socketstream.org](http://www.socketstream.org).
 
 
 ## Features
@@ -97,9 +95,9 @@ All this means no more connection latency, HTTP header overhead, polling, or clu
 
 ### Getting Started
 
-Ready to give it a whirl? Install [Node 0.6.X](http://nodejs.org/#download) then install SocketStream from NPM:
+Ready to give it a whirl? Install [Node 0.8.X](http://nodejs.org/#download) and checkout the latest code from master:
 
-    [sudo] npm install -g socketstream
+    [sudo] npm install git://github.com/socketstream/socketstream.git
 
 To generate a new empty SocketStream project type:
 
@@ -110,7 +108,8 @@ __Tip: Type `socketstream -h` to view all available options__
 Install the bundled (optional) dependencies:
 
     cd <name_of_your_project>
-    npm install
+    [sudo] npm link socketstream
+    [sudo] npm install
 
 To start your app simply type:
 
@@ -188,7 +187,7 @@ More examples coming soon!
 
 Please start with http://www.socketstream.org/tour which walks you through the key features and shows you the code.
 
-Documentation is constantly expanding and can be found in `/doc/guide/en`.
+Documentation is constantly expanding and currently available in [English](https://github.com/socketstream/socketstream/tree/master/doc/guide/en) and [Korean](https://github.com/socketstream/socketstream/tree/master/doc/guide/ko).
 
 ##### Developing (Client-side)
 
@@ -295,7 +294,9 @@ Back end scaling has yet to be properly documented, but we're keen to continue l
 
 ### Videos
 
-**NEW** [Watch the introductory presentation](http://2011.krtconf.com/videos/owen_barnes) I gave at [KrtConf](http://krtconf.com) last November. Although the first half of the video refers to the previous version (SocketStream 0.2), all the upcoming features I speak about are now available in SocketStream 0.3.
+
+* November 2011 - [Presentation to KrtConf.com](http://2011.krtconf.com/videos/owen_barnes), Portland
+* May 2012 - [Presentation to LNUG.org](http://vimeo.com/43027679), London (most recent)
 
 
 ### Developing on the SocketStream core

doc/guide/en/live_reload.md

@@ -15,6 +15,15 @@ As you typically would in `production` mode.
 
 ### Known issues
 
+#### VIM
+
+VIM creates a temporary file before replacing the real file. To prevent problems with Live Reload, change the write mode with:
+
+    :set nowritebackup
+
+
+#### Too many files
+
 Live Reload is built on Node's `fs.watch()` API which works differently on each operating system. For example, on Linux you'll get an `EMFILE` error if you have many files in your `client` directory. Change this limit with:
 
     sudo vi /etc/sysctl.conf