hibas123/node_vlc_remote
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Updated readme

Browse Source
This commit is contained in:
margau 2017-06-01 10:58:29 +02:00
parent d652e0ce79
commit 9d90602a3f
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md Normal file → Executable file
View 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