Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Updated README.markdown

  • Loading branch information...
commit aec974477e70b68581dbc3b01bd89741c3e580d0 1 parent 4ddeb10
Nathan L Smith authored May 02, 2010

Showing 1 changed file with 47 additions and 6 deletions. Show diff stats Hide diff stats

  1. 53  README.markdown
53  README.markdown
Source Rendered
... ...
@@ -1,10 +1,51 @@
1  
-Interoperable JScript
2  
-=====================
  1
+CommonJScript
  2
+=============
3 3
 
4  
-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).
  4
+CommonJScript is an implementation of the [CommonJS API](http://commonjs.org/) for Classic ASP and Windows Script Host.
5 5
 
6  
-# Usage
  6
+The [Modules/1.0](http://commonjs.org/specs/modules/1.0/) specification is currently implemented. Various others are planned for the future.
7 7
 
8  
-`require.js` can be included in a ASP/JScript page or WScript job to provide the `require` function.
  8
+A few rudimentary modules are included in the *lib* directory.
9 9
 
10  
-`test.asp` and `test.wsf` include runners for some of the tests in the [interoperablejs test suite](http://code.google.com/p/interoperablejs/).
  10
+Usage
  11
+-----
  12
+
  13
+*require.js* can be included in a ASP page or WScript job to provide the `require` function.
  14
+
  15
+Tests
  16
+-----
  17
+
  18
+The [CommonJS modules test suite](http://github.com/commonjs/commonjs/tree/master/tests/modules/1.0) can be run:
  19
+
  20
+    git submodule init
  21
+    git submodule update
  22
+
  23
+Run `cscript test.wsf` from the *test* directory for Windows Script Host (CLI), or load *test.asp* on ASP.
  24
+
  25
+Acknowledgements
  26
+----------------
  27
+
  28
+The module loading code is mostly taken from [Narwhal](http://narwhaljs.org).
  29
+
  30
+License
  31
+-------
  32
+
  33
+Copyright (c) 2010 Nathan L Smith <nlloyds@gmail.com>
  34
+
  35
+Permission is hereby granted, free of charge, to any person obtaining a copy
  36
+of this software and associated documentation files (the "Software"), to deal
  37
+in the Software without restriction, including without limitation the rights
  38
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  39
+copies of the Software, and to permit persons to whom the Software is
  40
+furnished to do so, subject to the following conditions:
  41
+
  42
+The above copyright notice and this permission notice shall be included in
  43
+all copies or substantial portions of the Software.
  44
+
  45
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  46
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  47
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  48
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  49
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  50
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  51
+THE SOFTWARE.

0 notes on commit aec9744

Please sign in to comment.
Something went wrong with that request. Please try again.