Merge pull request #157 from brendandburns/namespace

Add better docs to the WebSocket example.

Author: brendandburns

examples/src/main/java/io/kubernetes/client/examples/WebSocketsExample.java

@@ -25,6 +25,18 @@
 import java.io.OutputStream;
 import java.io.Reader;
 
+/**
+ * This is a pretty low level, most people won't need to use WebSockets
+ * directly.
+ *
+ * If you do need to run it, you can run:
+ *   mvn exec:java \
+ *     -Dexec.mainClass=io.kubernetes.client.examples.WebSocketsExample \
+ *     -Dexec.args=/api/v1/namespaces/default/pods/<podname>/attach?stdout=true
+ *
+ * Note that you'd think 'watch' calls were WebSockets, but you'd be wrong,
+ * they're straight HTTP GET calls.
+ */
 public class WebSocketsExample {
     public static void main(String... args) throws ApiException, IOException {
         final ApiClient client = Config.defaultClient();
@@ -47,4 +59,4 @@ public void textMessage(Reader in) {
             }
         });
     }
-}
+}