Permalink
Browse files

Adding README and LICENSE files

  • Loading branch information...
1 parent 3a5178b commit c1165e1e53ff357f1233c6ccc00a17b82c8aa310 @jbrantly committed Apr 12, 2010
Showing with 57 additions and 0 deletions.
  1. +19 −0 LICENSE
  2. +38 −0 README
View
@@ -0,0 +1,19 @@
+Copyright (c) 2010 James Brantly
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
View
@@ -0,0 +1,38 @@
+A general purpose browser-side CommonJS module loader
+
+Yabble is a general purpose browser-side CommonJS module loader. Other similar module loaders are available, but Yabble strives to be a flexible loader in a small package.
+
+** NOTE: This is an early release. See below for more information **
+
+Features:
+ * Compliant with Modules 1.0
+ * Supports async XHR/eval()
+ - Allows the use of non-transport-wrapped module code for quick development
+ * Supports script tags with a Transport format
+ - Easier debugging, potential for file concatenation
+ * Includes a tool for automatically wrapping modules in a Transport format
+ * Supports require.ensure() for lazy-loading modules
+ * Small size (<500 lines, ~13kb raw, ~4kb minified, and <2kb when minified/gzipped)
+
+Roadmap:
+ * Stability
+ - Better cross-browser compliance
+ - More unit tests
+ - Better unit testing framework
+ * Features
+ - Implement support for Modules 1.1(.1)
+ - Complete support for Transport/D
+ - Implement support for Transport/C
+ - Explicit support for concatenated Transport files in loader and tooling
+ * Loader
+ - Use loader code in tooling (no copy/paste code)
+ - Expand supported engines for tooling (node.js)
+ - Better consideration for platform (line endings, encoding, etc)
+
+Notes on the current release:
+
+This is the first release and is currently unsuitable for any sort of production work. The loader has passed the Module 1.0 unit tests on IE 6/7 and FF 3. While complete cross-browser support is a short-term goal, this release does not offer it.
+
+The tooling (yabbler.js) currently supports the Rhino javascript engine and is very under-developed. It is offered as a preview of what is to come.
+
+For example usage for both the loader and the tooling, please see the Modules 1.0 unit tests.

0 comments on commit c1165e1

Please sign in to comment.