Skip to content

Commit c6bf9c7

Browse files
committed
Update README
1 parent 5fa4aa8 commit c6bf9c7

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,9 @@ After that you can check all results in [http://localhost:8080/webdriver-ts/tabl
308308

309309
## 4. Contributing a new implementation
310310

311-
## TL;DR
311+
## 4.1 Example instructions for a real implementation
312+
Thanks @dsvorc41 for providing the following description:
313+
TL;DR:
312314
![demo](https://github.com/dsvorc41/js-framework-benchmark/assets/20287188/91ae2d64-7362-4be8-b88f-e52637b33fa5)
313315

314316
1. Install all of the root-level dependencies
@@ -446,7 +448,7 @@ After that you can check all results in [http://localhost:8080/webdriver-ts/tabl
446448
12. Open the report in your browser (NOTE: the server must still be running if you want to see this page)
447449
1. `http://localhost:8080/webdriver-ts-results/table.html`
448450

449-
## 4.1 Building the app
451+
## 4.2 Building the app
450452

451453
For contributions it is basically sufficient to create a new directory for your framework that supports `npm install` and `npm run build-prod` and can be then opened in the browser. All other steps are optional. Let's simulate that by copying vanillajs.
452454

@@ -468,7 +470,7 @@ In most cases you'll need `npm install` and `npm run build-prod` and then check
468470
469471
(Of course in reality you'd rather throw out the javascript source files and use your framework there instead of only changing the html file.)
470472
471-
## 4.2 Adding your new implementation to the results table.
473+
## 4.3 Adding your new implementation to the results table.
472474
473475
(Notice: Updating common.ts is no longer necessary, super-vanillajs is visible in the result table)
474476
@@ -506,7 +508,7 @@ The other important, but optional properties for js-framework-benchmark are show
506508
507509
You can set an optional different URL if needed or specify that your DOM uses a shadow root.
508510
509-
## 4.3 Submitting your implementation
511+
## 4.4 Submitting your implementation
510512
511513
Contributions are very welcome. Please use the following rules:
512514

0 commit comments

Comments
 (0)