Permalink
Browse files

Updated README.markdown

  • Loading branch information...
1 parent 4ddeb10 commit aec974477e70b68581dbc3b01bd89741c3e580d0 @smith committed May 3, 2010
Showing with 47 additions and 6 deletions.
  1. +47 −6 README.markdown
View
@@ -1,10 +1,51 @@
-Interoperable JScript
-=====================
+CommonJScript
+=============
-This is an implementation of the [JavaScript Securable Modules Specification](https://wiki.mozilla.org/ServerJS/Modules/SecurableModules) meant to run on ASP or through Windows Script Host. The implentation is based on the one used in [Narwhal](http://github.com/tlrobinson/narwhal/tree/master).
+CommonJScript is an implementation of the [CommonJS API](http://commonjs.org/) for Classic ASP and Windows Script Host.
-# Usage
+The [Modules/1.0](http://commonjs.org/specs/modules/1.0/) specification is currently implemented. Various others are planned for the future.
-`require.js` can be included in a ASP/JScript page or WScript job to provide the `require` function.
+A few rudimentary modules are included in the *lib* directory.
-`test.asp` and `test.wsf` include runners for some of the tests in the [interoperablejs test suite](http://code.google.com/p/interoperablejs/).
+Usage
+-----
+
+*require.js* can be included in a ASP page or WScript job to provide the `require` function.
+
+Tests
+-----
+
+The [CommonJS modules test suite](http://github.com/commonjs/commonjs/tree/master/tests/modules/1.0) can be run:
+
+ git submodule init
+ git submodule update
+
+Run `cscript test.wsf` from the *test* directory for Windows Script Host (CLI), or load *test.asp* on ASP.
+
+Acknowledgements
+----------------
+
+The module loading code is mostly taken from [Narwhal](http://narwhaljs.org).
+
+License
+-------
+
+Copyright (c) 2010 Nathan L Smith <nlloyds@gmail.com>
+
+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.

0 comments on commit aec9744

Please sign in to comment.