update README, fix sync

Author: krausest

README.md

@@ -141,9 +141,11 @@ npm run build-prod
 ```
 now run the benchmark driver for the vanillajs-keyed framework:
 ```
-npm run selenium -- --count 3 --framework vanillajs-keyed
+npm run bench keyed/vanillajs
 ```
-Just lean back and watch chrome run the benchmarks. It runs each benchmark 3 times for the vanillajs-keyed framework.
+Just lean back and watch chrome run the benchmarks. 
+If it doesn't complain then the html for the table should be fine and your categorization as keyed or non-keyed should also be correct.
+
 
 You should keep the chrome window visible since otherwise it seems like paint events can be skipped leading to wrong results. On the terminal will appear various log statements.
 
@@ -154,6 +156,12 @@ cat results/vanillajs-keyed_01_run1k.json
 ```
 As you can see the mean duration for create 1000 rows was 144 msecs.
 
+You can also check whether the implementation appears to be compliant to the rules:
+```
+npm run check keyed/vanillajs
+```
+If it finds anything it'll report an ERROR.
+
 ## 6. Building the result table
 
 Install libraries
@@ -173,7 +181,7 @@ Now a result table should have been created which can be opened on [http://local
 There's nothing in table except for the column vanillajs-keyed at the right end of the first table.
 ![First Run Results](images/staticResults.png?raw=true "First Run Results")
 
-## Optional 6.1 Adding your new implementation to the results table.
+## 6.1 Adding your new implementation to the results table.
 
 (Notice: Updating common.ts is no longer necessary, super-vanillajs is visible in the result table)
 
@@ -218,34 +226,37 @@ This is not for the faint at heart. You can build all frameworks simply by issui
 cd ..
 npm run build-prod
 ```
-After downloading the whole internet it starts building it. Basically there should be no errors during the build, but I can't guarantee that the dependencies won't break.
-You can now run selenium for all frameworks by invoking
-`npm run selenium`
+After downloading the whole internet it starts building it. Basically there should be no errors during the build, but I can't guarantee that the dependencies won't break. (There's a docker build on the way which might make building it more robust. See https://github.com/krausest/js-framework-benchmark/wiki/%5BUnder-construction%5D-Build-all-frameworks-with-docker)
+You can now run the benchmark for all frameworks by invoking
+`npm run bench-all`
 in the root directory.
 
 After that you can check all results in [http://localhost:8080/webdriver-ts/table.html](http://localhost:8080/webdriver-ts/table.html).
 
 ## Tips and tricks
 
-* You can select multiple frameworks and benchmarks for running with prefixes like in the following example:
-`npm run selenium -- --framework angular bob --benchmark 01_ 02_`
+* You can select multiple frameworks and benchmarks for running with prefixes like in the following example in the webdriver-ts directory:
+`npm run bench -- --framework angular bob --benchmark 01_ 02_`
 runs the test for all frameworks that contain either angular or bob, which means all angular versions and bobril and all benchmarks whose id contain 01_ or 02_
+* You can also run implementations by passing their directory names (cd to webdriver-ts):
+`npm run bench keyed/angular keyed/react` or if you want to pass more options it becomes: 
+`npm run bench -- --count 3 keyed/angular keyed/react`.
 * If you can't get one framework to compile or run, just move it out of the root directory and remove it from common.ts, recompile and re-run
 * To achieve good precision you should run each framework often enough. I recommend at least 10 times, more is better. The result table contains the mean and the standard deviation. You can seen the effect on the latter pretty well if you increase the count.
 * One can check whether an implementation is keyed or non-keyed via `npm run isKeyed` in the webdriver-ts directory. You can limit which frameworks to check in the same way as the webdriver test runner like e.g. `npm run isKeyed -- --framework svelte`. The program will report an error if a benchmark implementation is incorrectly classified.
 
 ## How to contribute
 
 Contributions are very welcome. Please use the following rules:
-* Name your directory frameworks/[keyed|non-keyed][FrameworkName]
+* Name your directory frameworks/[keyed|non-keyed]/[FrameworkName]
 * Each contribution must be buildable by `npm install` and `npm run build-prod` command in the directory. What build-prod does is up to you. Often there's an `npm run build-dev` that creates a development build
 * Every implementation must use bootstrap provided in the root css directory.
 * All npm dependencies should be installed locally (i.e. listed in your package.json). Http-server should not be a local dependency. It is installed from the root directory to allow access to bootstrap.
 * Please use *fixed version* numbers, no ranges, in package.json. Otherwise the build will break sooner or later - believe me. Updating works IMO best with npm-check-updates, which keeps the version format.
 * Webdriver-ts must be able to run the perf tests for the contribution. This means that all buttons (like "Create 1,000 rows") must have the correct id e.g. like in vanillajs. Using shadow DOM is a real pain for webdriver. The closer you can get to polymer the higher the chances I can make that contribution work.
 * Don't change the ids in the index.html, since the automated benchmarking relies on those ids.
-* You don't need to update /index.html. It's created with a script (see 6.2 above).
-* You can assert the correct keyed or non-keyed behaviour by using the isKeyed test tool. cd to webdriver-ts and call it like `npm run isKeyed -- --framework [your framework]`. It'll print an error if your framework behaves other as specified.
+* Please push only files in your framework folder (not index.html or results.json)
+* **Please make sure your implementation is validated by the test tool.** cd to webdriver-ts and invoke it with `npm run check [keyed|non-keyed]/[FrameworkName]`. It'll print an error if your framework behaves other as specified. It'll print a big ERROR explaining if it isn't happy with the implementation.
 * Please don't commit any of the result file webdriver-ts/table.html, webdriver-ts-results/src/results.ts or webdriver-ts-results/table.html. I use to run the benchmarks after merging and publish updated (temporary) results.
 * The latest stable chrome can be used regarding web features and language level (babel-preset-env "last 1 chrome versions")
 * **Please don't over-optimize. Other contributors will review your implementation so beware of discussions ([#521](https://github.com/krausest/js-framework-benchmark/pull/521), [#519](https://github.com/krausest/js-framework-benchmark/pull/519), [#430](https://github.com/krausest/js-framework-benchmark/issues/430)) and rejection if the community finds you cheating. When are you safe?**

package.json

@@ -16,7 +16,7 @@
     "docker-build-image": "docker build -t js-framework-benchmark-centos -f Dockerfile .",
     "docker-start": "cross-env-shell docker run --rm -d -p 8080:8080 --name js-framework-benchmark --volume ${INIT_CWD}:/src --volume js-framework-benchmark:/build js-framework-benchmark-centos",
     "docker-stop": "docker stop js-framework-benchmark",
-    "docker-sync": "docker exec -it js-framework-benchmark rsync -avC --exclude /index.html --exclude /framework/**/dist --exclude /webdriver-ts*/dist --exclude package-lock.json --exclude node_modules --exclude webdriver-ts/results*/ /src/ /build/",
+    "docker-sync": "docker exec -it js-framework-benchmark rsync -avC --exclude /index.html --exclude /framework/**/dist --exclude /webdriver-ts*/dist --exclude package-lock.json --exclude node_modules --exclude /webdriver-ts/results*/ /src/ /build/",
     "docker-build-frameworks": "npm run docker-sync && docker exec -it js-framework-benchmark npm install && docker exec -it js-framework-benchmark node build.js",
     "docker-install-webdriver": "npm run docker-sync && docker exec -it js-framework-benchmark npm run install-local",
     "docker-rebuild": "npm run docker-sync && docker exec -it -w /build/webdriver-ts js-framework-benchmark npm run rebuild --headless",