runtime-telnet-server/README.md

Telnet server for runtime.js

# runtime-telnet-server

## Telnet server for runtimejs

### Install:
```bash
npm install runtime-telnet-server
```

### Usage:
```javascript
// Note the '()', this starts the server.
var rtelnet = require('runtime-telnet-server')();
// OR
// All the parameters are optional
var rtelnet = require('runtime-telnet-server')([callback]);
// OR
var rtelnet = require('runtime-telnet-server')([options, [callback]]);
```
With no parameters, this listens on port 9000.

With callback:
```js
var rtelnet = require('runtime-telnet-server')(function() {
  // Do what you want
});
```

Options:
  * port, default is 9000

```js
var rtelnet - require('runtime-telnet-server')({
  port: 9090, // this is optional
});
```

### Client Usage:
This assumes you're on Unix. Windows, you're on your own (maybe use PuTTY?).
```bash
telnet your.host.ip.here (custom port or default 9000 port)
```

### NOTES:
The port used (default is 9000) must be free and usable, on both QEMU **and** the host.
Tested and working with the Unix telnet client. Yay! Just type in commands like the runtime shell.