Create README.md

michaelficarra · Jul 27, 2014 · 0bb5fa5 · 0bb5fa5
1 parent 4b73573
commit 0bb5fa5
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+everything.js
+=============
+
+A single javascript file that contains every ECMA-262 edition 5.1 grammatical production.
+
+### Usage Example
+
+Mocha:
+
+```js
+test("exercise my program", function(done) {
+  fs.readFile(require.resolve("everything.js"), function(err, programText) {
+    var program = esprima.parse("" + programText);
+    assert.equal(runMyProgramOn(program), /* expected value */, "message");
+    done();
+  });
+});
+```