From 9e3318e5ddd8976b44653bedcf7f4ae430c6f1d1 Mon Sep 17 00:00:00 2001
From: milad <milad@miladnazeri.com>
Date: Thu, 31 Oct 2019 09:36:58 -0700
Subject: [PATCH] added readme

---
 screenshare/.gitignore |  3 ++-
 screenshare/README.md  | 22 ++++++++++++++++++++++
 2 files changed, 24 insertions(+), 1 deletion(-)
 create mode 100644 screenshare/README.md

diff --git a/screenshare/.gitignore b/screenshare/.gitignore
index 7ebd067d27..427ed5858c 100644
--- a/screenshare/.gitignore
+++ b/screenshare/.gitignore
@@ -1,3 +1,4 @@
 hifi-screenshare-*/
 hifi-screenshare*.zip
-screenshare*.zip
\ No newline at end of file
+screenshare*.zip
+screenshare-*/
\ No newline at end of file
diff --git a/screenshare/README.md b/screenshare/README.md
new file mode 100644
index 0000000000..53e8a00ea2
--- /dev/null
+++ b/screenshare/README.md
@@ -0,0 +1,22 @@
+# Hifi-Screenshare
+
+The Screenshare app will allow easy desktop sharing by being launced from within the highfidelity interface.
+
+# Setup
+Create the following environment variable the hifi-screenshare app will use to get the proper connection info:
+hifiScreenshareURL="<URL for authentication>"
+
+# Screenshare API
+In order to launch the hifi-screenshare app from within interface, you will call the following:
+Screenshare.startScreenshare(displayName, userName, token, sessionID, apiKey);
+The app won't run without the correct info.
+
+# Files included
+packager.js : 
+Calling npm run packager will use this file to create the actual electron hifi-screenshare executable
+
+src/main.js :
+The main process file to configure the electron app
+
+srce/app.js :
+The render file to dispaly the screenshare UI
\ No newline at end of file