From 9d90602a3f87ec60da9692644ba5dae31d798c42 Mon Sep 17 00:00:00 2001
From: margau <dev@marvingaube.de>
Date: Thu, 1 Jun 2017 10:58:29 +0200
Subject: [PATCH] Updated readme

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 mode change 100644 => 100755 README.md

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