From cf81a579a59b43d9f3a11b8339319090f9ee960a Mon Sep 17 00:00:00 2001
From: Annyv2 <Annyv2@users.noreply.github.com>
Date: Mon, 23 Nov 2015 19:57:18 -0430
Subject: [PATCH] Create README.md

---
 example/README.md | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 example/README.md

diff --git a/example/README.md b/example/README.md
new file mode 100644
index 0000000..e9a6ce2
--- /dev/null
+++ b/example/README.md
@@ -0,0 +1,22 @@
+# Auth0 + Socket.io
+
+This is the seed project you need to use if you're going to create a Socket.io single page app that will use Auth0.
+
+## Running the example
+
+In order to run the example, you need to have `node` installed. 
+
+You also need to set the ClientSecret, ClientId and Domain for your Auth0 app as variables with the following names respectively: `AUTH0_CLIENT_SECRET`, `AUTH0_CLIENT_ID` and `AUTH0_DOMAIN`.
+
+````bash
+# auth0-variables.js file
+AUTH0_CLIENT_SECRET=myCoolSecret
+AUTH0_CLIENT_ID=myCoolClientId
+AUTH0_DOMAIN=samples.auth0.com
+````
+On your application in Auth0 you need to set http://localhost:3001 as an Allowed Origin (CORS) in the application settings page. 
+
+1. run npm install 
+1. run node index.js in the directory of this project.
+
+Go to [http://localhost:3001](http://localhost:3001) and you'll see the app running :).