readme

Author: tkafka

README.md

@@ -0,0 +1,40 @@
+Node.js proxy for server-side interactive cli programs
+---
+
+Define jobs in [jobs.js](https://github.com/tkafka/node-console-proxy/blob/master/jobs.js), and let users run them and interact with their stdin through web browser.
+
+Try the [showcase](/showcase), I recommend talking to [Eliza](https://github.com/tkafka/eliza-cli) :).
+
+![Talking to Eliza](http://tmskfk.com:3999/images/eliza-cli.png)
+
+This is very useful for all kinds of automation, as you don't have to develop web frontend for your scripts and programs.
+
+Example jobs.js file:
+
+	module.eports = {
+		showcase: {
+			name: 'Showcase',
+			description: '',
+			cwd: __dirname, // or __dirname if missing
+			variants: {
+				eliza: {
+					name: 'Eliza',
+					description: 'Eliza chat bot. Isn\'t she awesome?',
+					cwd: '~/eliza-cli', // cwd can be overriden for a job variant
+					command: 'node',
+					args: ['eliza']
+				},
+				ls: {
+					name: 'ls',
+					command: 'ls',
+					args: []
+				}
+			}
+		}
+	};
+
+Uses [socket.io](http://socket.io/) to keep the link with server while job is running, kills job on server when user closes browser to prevent resource leaking.
+
+Made in Prague by [@keff85](http://twitter.com/keff85).
+
+Source at [github.com/tkafka/node-console-proxy](https://github.com/tkafka/node-console-proxy).

public/images/eliza-cli.png

@@ -2,14 +2,15 @@ extends layout
 
 block content
 	.message
-		h2 Node.js proxy for server-side interactive cli programs
-
 		:markdown
+			Node.js proxy for server-side interactive cli programs
+			---
+
 			Define jobs in [jobs.js](https://github.com/tkafka/node-console-proxy/blob/master/jobs.js), and let users run them and interact with their stdin through web browser.
 
 			Try the [showcase](/showcase), I recommend talking to [Eliza](https://github.com/tkafka/eliza-cli) :).
 
-			![Talking to Eliza](/images/eliza-cli.png)
+			![Talking to Eliza](/images/eliza-cli@2x.png)
 
 			This is very useful for all kinds of automation, as you don't have to develop web frontend for your scripts and programs.