diff --git a/README.md b/README.md old mode 100644 new mode 100755 index 4be1461..c103eb0 --- a/README.md +++ b/README.md @@ -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 \ No newline at end of file