Internal docs update

lib/resource/updater.js

@@ -1,8 +1,42 @@
-// @name        USO @require Updater  
-// @copyright   Copyright (c) 2009, Tim Smart, All Rights Reserved  
-// @license     http://github.com/Tim-Smart/USO-Updater/raw/master/license.txt  
-// @version     2.x.3b2  
-// @changelog   http://github.com/Tim-Smart/USO-Updater/commits/master
+// ## USO Updater, a Userscripts updater. This file contains all the Javasript logic for the updater.
+// Feel free to scroll down for the annotated source code.  
+//
+// Designed to be simple to use and implement, while also complex and
+// versitile if needed. There are two interfaces that you will need to
+// know about:
+//
+// * The GET parameter API, where HTTP GET parameters modify this output
+//   file
+// * The Javascript API, which can be observed below.
+//
+// A quick GET parameter rundown: (The valid parameters are in bold)
+// <code>http://updater.usotools.co.cc/**12345**.js?**api**=1&**lang**=en&**interval**=7&**update**=update</code>
+//
+// #### Required GET parameters:
+// * **12345**: Replace this with your script ID number, good times.
+
+// #### Optional GET parameters
+// * **api**: Want the Javascript API, `1` for yes, `0` for no. Simple.
+// * **lang**: Set this only if you want everybody to see the same language. Uses a 2 character language code.
+//             If you like people seeing the updater in their home language, don't set it. :D
+// * **interval**: Maximum number of days between updates. Minimum of 1
+// * **update**:
+//     * update: Direct install without bumping install count. How integral of you!
+//     * install: Straight to the goods. Doesn't show the homepage unless your script is
+//       naughty and un-listed. tut tut.
+//     * show: The default one. Shows the homepage on update.
+//
+// ### Credits
+// Thanks to the following for ideas / concepts / being cool:
+//
+// * [Photodeus](http://userscripts.org/users/photodeus) - The guy who posted the idea here: http://userscripts.org/topics/29195
+// * [Jesse Andrews](http://userscripts.org/users/anotherjesse) - For being a awesome USO host, and giving tips along the way
+// * [Marti Martz](http://userscripts.org/users/marti) - For arguing ideas to hell and back, then coming to general consensus
+// * [Sizzlemctwizzle](http://userscripts.org/users/sizzle) - A man full of good ideas
+// * Anyone else I missed, which is probably a lot. Edit your name in here and send me a pull / patch request :p
+//
+// **Anyways, onto the Javascript code we go!**
+
 
 // Create our API reference
 <?php if ( $api === true ) { ?>