Permalink
Browse files

adding readme

  • Loading branch information...
1 parent 43c64f0 commit 210d68436eac7f0291cc2b71c3bda8c47c296fa7 @moschel moschel committed Jan 6, 2011
Showing with 35 additions and 1 deletion.
  1. +34 −0 README
  2. +1 −1 synthetic.html
View
@@ -0,0 +1,34 @@
+What It Is
+
+Syn is a synthetic event library that pretty much handles typing, clicking, moving, and
+dragging exactly how a real user would perform those actions.
+
+Relevant Links
+
+1. http://jupiterjs.com/news/syn-a-standalone-synthetic-event-library
+2. http://javascriptmvc.com/#&who=Syn
+3. http://javascriptmvc.com/funcunit/syn/synthetic.html
+
+Using Syn
+
+You'd use syn to perform functional testing on a JavaScript application. Check out the demo
+page (3rd link above) for some examples. To add syn to your page, you have two options:
+
+1. Add each script with script tags
+
+There are 5 scripts to add to your page in the following order:
+
+1. synthetic.js
+2. mouse.js
+3. browsers.js
+4. key.js
+5. drag/drag.js
+
+2. Use steal
+
+If you are using StealJS as your dependency loader, just steal.plugins('syn'), and the dependencies
+will be loaded for you.
+
+Running Syn Tests
+
+Load syn/qunit.html in any browser to run all the tests. Load syn/drag/qunit.html to run the drag tests.
View
@@ -75,7 +75,7 @@
</div>
<script type='text/javascript' src='../../steal/steal.js'></script>
<script type='text/javascript'>
- steal.plugins('funcunit/synthetic','mxui/filler').start();
+ steal.plugins('funcunit/syn','mxui/filler').start();
</script>
<script type='text/javascript' src='demo/record.js'></script>
<script type='text/javascript' id="demo-source">

0 comments on commit 210d684

Please sign in to comment.