Skip to content

Commit

Permalink
doc updates, prepping for release.
Browse files Browse the repository at this point in the history
  • Loading branch information
jrburke committed Dec 16, 2010
1 parent 13b329b commit 20a3833
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 28 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -14,4 +14,4 @@ The standard require.js file is around 5KB when minified via Closure Compiler an

RequireJS works in IE 6+, Firefox 2+, Safari 3.2+, Chrome 3+, and Opera 10+.

Latest Release: [0.15.0](http://requirejs.org/docs/download.html)
Latest Release: [0.2.0](http://requirejs.org/docs/download.html)
4 changes: 2 additions & 2 deletions dist/post.html
@@ -1,8 +1,8 @@
</div>
<div id="footer" class="mono">
<span class="latest">Latest Release: <a href="http://requirejs.org/docs/download.html">0.15.0</a></span>
<span class="latest">Latest Release: <a href="http://requirejs.org/docs/download.html">0.2.0</a></span>
Open source: new BSD or MIT licensed
</div>
</div>
</div>

</body>
Expand Down
2 changes: 1 addition & 1 deletion dist/pre.html
Expand Up @@ -141,7 +141,7 @@ <h1>a javascript module loader</h1>
</ul>

<ul>
<li class="version">0.15.0 Docs</li>
<li class="version">0.2.0 Docs</li>
</ul>
</div>

Expand Down
2 changes: 2 additions & 0 deletions docs/api.html
Expand Up @@ -326,6 +326,8 @@ <h3><a name="i18n">Define an I18N Bundle</a><span class="sectionMark">&sect; 1.3

<p>require.js will use browser's navigator.language or navigator.userLanguage property to determine what locale values to use for my/nls/colors, your app does not have to change. If you prefer to set the locale, you can use the locale: configuration parameter to require.js (see the <strong>Configuration options</strong> section).</p>

<p><strong>Note</strong> that RequireJS will always use a lowercase version of the locale, to avoid case issues, so all of the directories and files on disk for i18n bundles should use lowercase locales.</p>

<p>require.js is also smart enough to pick the right locale bundle, the one that most closely matches the ones provided by my/nls/colors. For instance, if the locale is "en-us", then the "root" bundle will be used. If the locale is "fr-fr-paris" then the "fr-fr" bundle will be used.</p>

<p>require.js also combines bundles together, so for instance, if the french bundle was defined like so (omitting a value for red):</p>
Expand Down
49 changes: 29 additions & 20 deletions docs/download.html
Expand Up @@ -16,24 +16,21 @@ <h1>Download RequireJS</h1>
</div>

<div class="section">
<h2><a name="latest">Latest Release: 0.15.0</a><span class="sectionMark">&sect; 1</span></h2>
<h2><a name="latest">Latest Release: 0.2.0</a><span class="sectionMark">&sect; 1</span></h2>

<ul>
<li>The bundled jQuery options now use jQuery 1.4.4.</li>
<li>The jQuery sample project now includes the ability to use RequireJS plugins.</li>
<li>The jsonp! plugin has been removed, since, thanks to work by Kris Zyp, the core loader now supports loading JSONP dependencies by default. The <a href="http://requirejs.org/docs/api.html#jsonp">JSONP docs</a> have been updated accordingly.</li>
<li>The optimizer can now be run from any directory, not just the directory with the build profile.</li>
<li>r.js Node adapter is more robust, and it can handle using more Node-written modules by default now. Thanks to Francois Laberge for a great test case application that lead to improving the robustness of r.js.</li>
<li>Initial support for PS3 Netfront browser. Thanks to Chris Warren for investigating the load behavior of the browser. Not all tests pass, but the basic ones do.</li>
<li>Miscellaneous fixes, some listed in <a href="https://github.com/jrburke/requirejs/issues/closed#sort=updated">the issue tracker</a>.</li>
<li>Refactored core.</li>
<li>New loader plugin API support.</li>
<li>Improved Rhino and Node adapters</li>
<li>Bug fixes around loader plugins and the optimizer.</li>
</ul>

<div class="subSection">
<h4 class="hbox">
<a name="requirejs">require.js</a>
<span class="boxFlex"></span>
<a class="download" href="http://requirejs.org/docs/release/0.15.0/minified/require.js">Minified</a>
<a class="download" href="http://requirejs.org/docs/release/0.15.0/comments/require.js">With Comments</a>
<a class="download" href="http://requirejs.org/docs/release/0.2.0/minified/require.js">Minified</a>
<a class="download" href="http://requirejs.org/docs/release/0.2.0/comments/require.js">With Comments</a>
</h4>

<p>All you need to start using require.js in the browser. Does not include i18n, text, order plugins or Node/Rhino support.</p>
Expand All @@ -43,8 +40,8 @@ <h4 class="hbox">
<h4 class="hbox">
<a name="requirejsplugins">require.js with plugins</a>
<span class="boxFlex"></span>
<a class="download" href="http://requirejs.org/docs/release/0.15.0/minified/allplugins-require.js">Minified</a>
<a class="download" href="http://requirejs.org/docs/release/0.15.0/comments/allplugins-require.js">With Comments</a>
<a class="download" href="http://requirejs.org/docs/release/0.2.0/minified/allplugins-require.js">Minified</a>
<a class="download" href="http://requirejs.org/docs/release/0.2.0/comments/allplugins-require.js">With Comments</a>
</h4>

<p>require.js for use in the browser with the i18n, text, and order plugins included. </p>
Expand All @@ -54,8 +51,8 @@ <h4 class="hbox">
<h4 class="hbox">
<a name="jqueryrequirejs">jQuery 1.4.4 with require()</a>
<span class="boxFlex"></span>
<a class="download" href="http://requirejs.org/docs/release/0.15.0/minified/require-jquery-1.4.4.js">Minified</a>
<a class="download" href="http://requirejs.org/docs/release/0.15.0/comments/require-jquery-1.4.4.js">With Comments</a>
<a class="download" href="http://requirejs.org/docs/release/0.2.0/minified/require-jquery-1.4.4.js">Minified</a>
<a class="download" href="http://requirejs.org/docs/release/0.2.0/comments/require-jquery-1.4.4.js">With Comments</a>
</h4>

<p>A build of jQuery with integrated require() support. <strong>Does not include</strong> the i18n, text, and order plugins.</p>
Expand All @@ -65,8 +62,8 @@ <h4 class="hbox">
<h4 class="hbox">
<a name="jqueryrequirejsplugins">jQuery 1.4.4 with require() and plugins</a>
<span class="boxFlex"></span>
<a class="download" href="http://requirejs.org/docs/release/0.15.0/minified/requireplugins-jquery-1.4.4.js">Minified</a>
<a class="download" href="http://requirejs.org/docs/release/0.15.0/comments/requireplugins-jquery-1.4.4.js">With Comments</a>
<a class="download" href="http://requirejs.org/docs/release/0.2.0/minified/requireplugins-jquery-1.4.4.js">Minified</a>
<a class="download" href="http://requirejs.org/docs/release/0.2.0/comments/requireplugins-jquery-1.4.4.js">With Comments</a>
</h4>

<p>A build of jQuery with integrated require() support that includes the i18n, text, and order plugins.</p>
Expand All @@ -76,7 +73,7 @@ <h4 class="hbox">
<h4 class="hbox">
<a name="samplejquery">Sample jQuery 1.4.4 project with require()</a>
<span class="boxFlex"></span>
<a class="download" href="http://requirejs.org/docs/release/0.15.0/jquery-require-sample.zip">Download</a>
<a class="download" href="http://requirejs.org/docs/release/0.2.0/jquery-require-sample.zip">Download</a>
</h4>

<p>A zip file containing a build of jQuery with integrated require() support, with an sample project included to show how it can be used when using jQuery.</p>
Expand All @@ -85,9 +82,9 @@ <h4 class="hbox">
<div class="subSection">
<h4><a name="node">RequireJS adapter for Node</a></h4>

<p><strong><a href="http://requirejs.org/docs/release/0.15.0/node/r.js">r.js</a></strong>: use this file if you want to code to the RequireJS module format in Node. The <a href="node.html">Node instructions</a> explain how to use it. It includes all the code needed for RequireJS to function with Node.</p>
<p><strong><a href="http://requirejs.org/docs/release/0.2.0/node/r.js">r.js</a></strong>: use this file if you want to code to the RequireJS module format in Node. The <a href="node.html">Node instructions</a> explain how to use it. It includes all the code needed for RequireJS to function with Node.</p>

<p><strong><a href="http://requirejs.org/docs/release/0.15.0/node/index.js">index.js</a></strong>: the standard HTTP server-based Hello World app for Node, but coded to work with the r.js adapter. Download it in the same directory as r.js and then run this command:</p>
<p><strong><a href="http://requirejs.org/docs/release/0.2.0/node/index.js">index.js</a></strong>: the standard HTTP server-based Hello World app for Node, but coded to work with the r.js adapter. Download it in the same directory as r.js and then run this command:</p>

<pre><code>node r.js index.js
</code></pre>
Expand All @@ -99,7 +96,7 @@ <h4><a name="node">RequireJS adapter for Node</a></h4>
<h4 class="hbox">
<a name="optimizationtool">Optimization Tool / Full Source</a>
<span class="boxFlex"></span>
<a class="download" href="http://requirejs.org/docs/release/0.15.0/requirejs-0.15.0.zip">Download</a></h4>
<a class="download" href="http://requirejs.org/docs/release/0.2.0/requirejs-0.2.0.zip">Download</a></h4>

<p>A zip file that is the optimization tool for RequireJS. It also includes the full source for require.js and its plugins.</p>

Expand All @@ -110,6 +107,18 @@ <h4 class="hbox">
<div class="section">
<h2><a name="previous">Previous releases</a><span class="sectionMark">&sect; 2</span></h2>

<h3>0.15.0</h3>

<ul>
<li>The bundled jQuery options now use jQuery 1.4.4.</li>
<li>The jQuery sample project now includes the ability to use RequireJS plugins.</li>
<li>The jsonp! plugin has been removed, since, thanks to work by Kris Zyp, the core loader now supports loading JSONP dependencies by default. The <a href="http://requirejs.org/docs/api.html#jsonp">JSONP docs</a> have been updated accordingly.</li>
<li>The optimizer can now be run from any directory, not just the directory with the build profile.</li>
<li>r.js Node adapter is more robust, and it can handle using more Node-written modules by default now. Thanks to Francois Laberge for a great test case application that lead to improving the robustness of r.js.</li>
<li>Initial support for PS3 Netfront browser. Thanks to Chris Warren for investigating the load behavior of the browser. Not all tests pass, but the basic ones do.</li>
<li>Miscellaneous fixes, some listed in <a href="https://github.com/jrburke/requirejs/issues/closed#sort=updated">the issue tracker</a>.</li>
</ul>

<h3>0.14.5</h3>

<ul>
Expand Down
4 changes: 2 additions & 2 deletions require.js
@@ -1,5 +1,5 @@
/** vim: et:ts=4:sw=4:sts=4
* @license RequireJS 0.15.0+ Copyright (c) 2010, The Dojo Foundation All Rights Reserved.
* @license RequireJS 0.2.0 Copyright (c) 2010, The Dojo Foundation All Rights Reserved.
* Available via the MIT or new BSD license.
* see: http://github.com/jrburke/requirejs for details
*/
Expand All @@ -12,7 +12,7 @@
var require, define;
(function () {
//Change this version number for each release.
var version = "0.15.0+",
var version = "0.2.0",
commentRegExp = /(\/\*([\s\S]*?)\*\/|\/\/(.*)$)/mg,
cjsRequireRegExp = /require\(["']([\w\!\-_\.\/]+)["']\)/g,
ostring = Object.prototype.toString,
Expand Down
2 changes: 0 additions & 2 deletions tasks.txt
@@ -1,5 +1,3 @@
- Get order, i18n, text plugins to work with new system.
- Test all the build options/tests.
- npm example/integration?
- simple node example does not work
- need to document how to use the packages config with Node.
Expand Down

0 comments on commit 20a3833

Please sign in to comment.