Add readme

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..3c74aa5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+SWF Overlay
+===========
+This repository contains as3 classes designed to help create an SWF to use as an overlay for an online video stream.
+
+It was originally intended to be used with OBS's browser source plugin.
+
+The goal is to provide some tools to allow the SWF to talk to multiple data sources and manipulate elements on the time line.
+
+Use with Flash CS
+=================
+To use this stuff in your own .fla, first create a new ActionScript 3.0 document, then place all the .as files from this repository in the same folder as the .fla.
+
+Follow the following steps:
+
+-In flash, go to File > Publish Settings
+-Click the spanner icon next to the Script dropdown
+-In Document class enter Overlay
+-Click OK on both windows.
+
+Overlay.as is the entry point for the application, you will want to edit it to your needs.
+
+Security Jazz
+==============
+Do expirments and write this later lol