helium 0.1.0

data/History.txt

@@ -0,0 +1,5 @@
+=== 0.1.0 / 2009-11-02
+
+* First public release under the GPL v2
+* Includes Deployer, a web UI, and `install`, `create` and `serve` command line tools
+

data/LICENCE

@@ -0,0 +1,339 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/Manifest.txt

@@ -0,0 +1,35 @@
+History.txt
+LICENCE
+Manifest.txt
+README.txt
+Rakefile
+bin/he
+lib/helium.rb
+lib/helium/configurable.rb
+lib/helium/deployer.rb
+lib/helium/generator.rb
+lib/helium/jake.rb
+lib/helium/logger.rb
+lib/helium/trie.rb
+lib/helium/web.rb
+lib/helium/web_helpers.rb
+lib/helium/views/deploy.erb
+lib/helium/views/edit.erb
+lib/helium/views/index.erb
+lib/helium/views/layout.erb
+lib/helium/views/missing.erb
+templates/packages.js.erb
+templates/project/.gitignore
+templates/project/jake.yml.erb
+templates/project/Jakefile
+templates/project/source/__name__.js.erb
+templates/project/test/index.html.erb
+templates/web/config.ru
+templates/web/deploy.yml
+templates/web/custom.js
+templates/web/public/prettify.css
+templates/web/public/prettify.js
+templates/web/public/style.css
+test/test_helium.rb
+test/deploy.yml
+test/index.html

data/README.txt

@@ -0,0 +1,266 @@
+= Helium
+
+* http://github.com/othermedia/helium
+
+Helium is a Ruby application for running a Git-backed JavaScript package distribution
+system. It comes with a web frontend that allows Git-hosted projects to be downloaded,
+built and served from a single domain, allowing any number of other sites to use the
+projects and receive automatic updates when new versions are deployed.
+
+Helium is free software, released under the GPL licence. Please see the
+<tt>LICENCE</tt> file for details.
+
+
+== Overview
+
+The deployer is designed to allow JavaScript packages to be easily shared between client
+websites without the need to copy-paste code from project to project. It allows you to
+run a centralized server on which JavaScript code is deployed from Git repositories,
+letting you easily push code updates to any sites using the hosted scripts. Client
+sites are able to specify which branch or tag of a package they wish to use, and code
+dependencies are transparently handled so that each site loads only the code it needs.
+
+The system is based around the JS.Class package manager (http://jsclass.jcoglan.com/packages.html),
+which provides a pure-JavaScript dependency manager for on-demand loading of JavaScript
+objects. Helium programmatically generates a package listing from metadata stored in Git
+repositories, so that client projects using this system do not have to maintain the list
+themselves. The only code required in each client project is this:
+
+  <!-- Step 1. Load JS.Class package manager and the package listing -->
+  <script src="http://helium.example.com/js/helium.js" type="text/javascript"></script>
+  
+  <!-- Step 2. Declare which branches to use -->
+  <script type="text/javascript">
+  Helium.use('yui', '2.7.0');
+  Helium.use('ojay', '0.4.1');
+  </script>
+
+After this, the <tt>require()</tt> function can be used to load any object deployed to
+the central server on demand. See the above-linked JS.Class documentation for more info.
+
+
+== Requirements
+
+Before deploying this app, you will need Ruby, RubyGems, Passenger (mod_rack), and Git
+installed on your webserver. Helium's web frontend assumes you will be using Rack to
+serve the application. You will also need these gems, though RubyGems should install
+these for you:
+
+  sudo gem install hoe grit jake packr oyster sinatra rack
+
+
+== Installation
+
+To install from Rubyforge:
+
+  sudo gem install hoe helium
+
+To install from GitHub:
+
+  sudo gem install hoe
+  git clone git://github.com/othermedia/helium.git
+  cd helium
+  ln -s README.rdoc README.txt
+  rake install_gem
+
+With the gem installed, you can install a copy of the web app anywhere on your system
+using the <tt>he install</tt> command with the name of the directory to create:
+
+  he install helium-app
+
+This will give you the following files:
+
+  helium-app/
+      public/
+          style.css etc.
+      config.ru
+      custom.js
+      deploy.yml
+
+The files <tt>deploy.yml</tt> and <tt>custom.js</tt> are editable through the web frontend,
+and must be writable by the web server. You can restrict write access to certain IP addresses
+using the configure block in <tt>config.ru</tt>, by default this is:
+
+  Helium::Web.configure do |config|
+    config.allow_ips ['0.0.0.0', '127.0.0.1']
+  end
+
+
+=== Apache setup
+
+To serve this application, just set up an Apache VHost whose +DocumentRoot+ is the
+<tt>helium-app/public</tt> directory. Passenger should do the rest.
+
+In addition, the Apache user will need read/write access to <tt>helium-app/deploy.yml</tt> and
+<tt>helium-app/custom.js</tt>, which are editable through the web frontend. The application will
+generate a directory at <tt>helium-app/lib</tt>, which will be used to check out and build
+projects from Git, and will copy any generated JavaScript files to <tt>helium-app/public/js</tt>;
+Apache will need read/write access to these directories.
+
+
+== Usage
+
+For the rest of this article, we'll assume the deployment app is running at
+http://helium.example.com, and the app is stored in the directory <tt>helium-app</tt>
+as described above.
+
+=== JavaScript project setup
+
+To deploy a project using this system, two conditions must be fulfilled: the project must
+be hosted in a Git repository, and it must have a <tt>jake.yml</tt> build file in its
+root directory. We use Jake (http://github.com/jcoglan/jake) to build checked-out projects
+and extract dependency data. Even if your project doesn't need a complex build process, it
+must still declare the objects it provides and requires so it can be deployed using the
+package manager. Each package must provide +provides+ and (optionally) +requires+ fields
+in its metadata. For example, here's a <tt>jake.yml</tt> file for a +Panel+ package, which
+provides the +panel+ function and +Panel+ and +PanelOverlay+ classes, and depends on
+<tt>JS.Class</tt>, <tt>Ojay</tt>, <tt>Ojay.HTML</tt> and <tt>Ojay.ContentOverlay</tt>:
+
+  ---
+  source_directory:   .
+  build_directory:    .
+  layout:             together
+  
+  builds:
+    min:
+      shrink_vars:    true
+      private:        true
+  
+  packages:
+    
+    panel:
+      files:
+        - panel
+      meta:
+        provides:
+          - panel
+          - Panel
+          - PanelOverlay
+        requires:
+          - JS.Class
+          - Ojay
+          - Ojay.HTML
+          - Ojay.ContentOverlay
+
+The project *must* have a build called +min+, and may have other builds. This deployment
+system exports the +min+ build for public use. You may use whatever compression settings
+you like for this build, and the project may contain any number of packages. See Jake
+(http://github.com/jcoglan/jake) for more documentation on these build files.
+
+Note that objects listed under +provides+ and +requires+ should be the runtime reference
+names of JavaScript objects, and anything in the +requires+ list should be provided by
+some other package known to the deploy system.
+
+If you're starting a new project, Helium comes with a command line tool that generates
+some stub code, a <tt>jake.yml</tt> file and a test page. Just run the following to
+create a new project, replacing <tt>project-name</tt> with the name of your library.
+
+  he create project-name
+
+After generating a project, you will need to edit its dependencies in <tt>jake.yml</tt>
+and edit <tt>test/index.html</tt> to reference your Helium server so that dependencies
+can be loaded.
+
+Running +jake+ from the new project directory will build the library for you and generate
+a JS.Packages manifest for it. The test page uses <tt>require()</tt> to load your library,
+so you'll know if any of its dependency data is missing.
+
+Helium also comes with a command line tool for starting a webserver in a local directory;
+this is useful for testing code that requires a domain name, such as Ajax calls, Google
+Maps widgets, etc. Run this command to serve your test files using this server:
+
+  he serve project-name/test
+
+The server runs on <tt>localhost:8000</tt>, so for example the file <tt>test/index.html</tt>
+will be available at <tt>http://localhost:8000/index.html</tt> on your machine.
+
+=== The deployment process
+
+Our deployment system performs the following steps on every project registered:
+
+* Copies its Git repo into <tt>helium-app/lib/repos/{project name}</tt>. If the repo is already
+  present, we use <tt>git fetch</tt> to update it, otherwise we use <tt>git clone</tt>.
+* Exports the head revision of every branch and every tag in the repo into its own
+  directory at <tt>helium-app/lib/static/{project}/{branch}</tt>.
+* Builds every exported copy using Jake, if a <tt>jake.yml</tt> is present. This stage
+  extracts the +provides+ and +requires+ data from the Jake build process, keeping
+  track of which build file provides which JavaScript objects.
+* Generates a file at <tt>helium-app/public/js/helium.js</tt>, which lists all the files
+  that Jake has built and which objects they provide using the JS.Class package manager
+  API (see http://jsclass.jcoglan.com/packages.html).
+
+=== Using the deployment app
+
+On first accessing http://helium.example.com, there will be no JavaScript projects
+listed. To add projects, we need to edit a YAML file listing projects and their Git
+URIs. To support the client-side package manager, the deploy system must at least have
+the JS.Class project registered. Projects are listed as key-value pairs by project name
+and Git URI.
+
+Go to http://helium.example.com/config and enter the following projects:
+
+  ---
+  js.class:
+    repository:       git://github.com/jcoglan/js.class.git
+    version:          2.1.x
+
+  projects:
+    yui:              git://github.com/othermedia/yui.git
+    ojay:             git://github.com/othermedia/ojay.git
+
+After clicking 'Save', these projects should be listed in the sidebar. Check all three,
+and hit 'Deploy' to import them all into the deploy system. After a few seconds you should
+see a log output telling you which projects and branches were built. There should also
+now be a JavaScript file at http://helium.example.com/js/helium.js that lists the files
+available on the server.
+
+=== Client-side package management
+
+The client side of the distribution system is the JS.Class package manager (documented
+at http://jsclass.jcoglan.com/packages.html). This provides a dependency manager and a
+simple way to load JavaScript objects on demand. To set it up, you just need the following
+in the head of your HTML pages:
+
+  <script src="http://helium.example.com/js/helium.js" type="text/javascript"></script>
+  
+  <script type="text/javascript">
+  Helium.use('yui', '2.7.0');
+  Helium.use('ojay', '0.4.1');
+  </script>
+
+To explain the above code: the file <tt>helium.js</tt> contains the JS.Class core and
+package manager and a list of packages generated by Helium during the build process.
+Then we need to configure the package manager; <tt>Helium.use()</tt> must be called to
+tell it which projects and which branch of each project we want to use. You can also set
+the variable <tt>Helium.PATH</tt> if you've set Helium up to serve script files from a
+nonstandard location. By default it is set to:
+
+  Helium.PATH = 'http://{ your domain }/js';
+
+Note that the above only loads one external script -- the <tt>Helium.use()</tt> calls do not
+load any extra code, they just tell the system which version of each project to use if and
+when we need to load them.
+
+=== Loading libraries in JavaScript
+
+With the above script tags in place, you should use the <tt>require</tt> function to declare
+which objects you want to use in each inline script. For example:
+
+  <script type="text/javascript">
+  require('Ojay.HTML', 'PanelOverlay', function() {
+      
+      var overlay = new PanelOverlay({width: 300, height: 200}),
+          title   = Ojay.HTML.h2('Hello, world!');
+      
+      overlay.setContent(title)
+             .center()
+             .show('fade');
+  });
+  </script>
+  
+Only <tt>require()</tt> the objects you're directly using. The package manager should
+handle loading any other objects your code depends on; that's what all the +provides+ and
++requires+ data was for in the configuration files mentioned above. The package manager
+only downloads extra scripts if any of the objects needed to run your code are not defined;
+no script is ever loaded more than once per page.
+