Updated readme
This commit is contained in:
parent
d652e0ce79
commit
9d90602a3f
16
README.md
Normal file → Executable file
16
README.md
Normal file → Executable file
@ -1,2 +1,18 @@
|
||||
# node_vlc_rc
|
||||
NodeJS Binding for the VLC Media Player remote control
|
||||
|
||||
## Example
|
||||
### Create a new VLC instance
|
||||
```javascript
|
||||
var VLC_RC = require('vlc_rc').VLC_RC;
|
||||
var VLC = new VLC_RC();
|
||||
```
|
||||
|
||||
You can pass options too:
|
||||
|
||||
```javascript
|
||||
var VLC = new VLC_RC({verbose: true});
|
||||
```
|
||||
* Available Settings *
|
||||
* *verbose* (Boolean): true or false, display verbose information
|
||||
* *debug* (Boolean): true or false, pipe VLC-Output to console
|
Loading…
Reference in New Issue
Block a user