Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

license file, modernize the readme

  • Loading branch information...
commit 889df5d718e766520da17f56f1cb7fd9ae6eff55 1 parent 3f0490f
@substack authored
Showing with 26 additions and 46 deletions.
  1. +18 −0 LICENSE
  2. +8 −46 README.markdown → readme.markdown
View
18 LICENSE
@@ -0,0 +1,18 @@
+This software is released under the MIT license:
+
+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
54 README.markdown → readme.markdown
@@ -1,10 +1,8 @@
-vm-browserify
-=============
+# vm-browserify
-Emulate node's vm module for the browser.
+emulate node's vm module for the browser
-example
-=======
+# example
Just write some client-side javascript:
@@ -43,51 +41,16 @@ and when you load the page you should see:
result = 105
```
-methods
-=======
+# methods
-vm.runInNewContext(code, context={})
-------------------------------------
+## vm.runInNewContext(code, context={})
Evaluate some `code` in a new iframe with a `context`.
Contexts are like wrapping your code in a `with()` except slightly less terrible
because the code is sandboxed into a new iframe.
-browser compatability
-=====================
-
-All modern browsers are supported.
-
-If you have a [browserling](http://browserling.com) account,
-from the testling/ directory just do:
-
-```
-$ ./test.sh substack@gmail.com
-Enter host password for user 'substack@gmail.com':
-chrome/17.0:
- vmRunInNewContext ................................. 5/5
-
-iexplore/9.0:
- vmRunInNewContext ................................. 5/5
-
-firefox/10.0:
- vmRunInNewContext ................................. 5/5
-
-safari/5.1:
- vmRunInNewContext ................................. 5/5
-
-opera/11.6:
- vmRunInNewContext ................................. 5/5
-
-total ............................................... 25/25
-```
-
-In IE8 and IE7, running `vm.runInNewContext()` more than once can cause the
-browsers to hang for some reason. Otherwise they work too.
-
-install
-=======
+# install
This module is depended upon by browserify, so you should just be able to
`require('vm')` and it will just work. However if you want to use this module
@@ -97,7 +60,6 @@ directly you can install it with [npm](http://npmjs.org):
npm install vm-browserify
```
-license
-=======
+# license
-MIT/X11
+MIT
Please sign in to comment.
Something went wrong with that request. Please try again.