44
55# blockdom
66
7- _ Probably the fastest virtual dom library in the world _
7+ _ Probably the fastest virtual dom library in the world! _
88
99IMPORTANT: ` blockdom ` is just a proof of concept and a place to experiment some ideas. This is
1010not intended to be used in a real application, no real support will be given! However, it is
@@ -22,31 +22,40 @@ Note that it is not a framework. It does not even have the concept of components
2222other frameworks could be added. See the documentation for a tutorial on that
2323topic.
2424
25+
2526## How to Install
2627
27- ** NPM **
28+ ### With Package Managers
2829
29- ``` js
30- npm i blockdom
31- yarn add blockdom
30+ Installing using NPM:
31+ ``` bash
32+ npm install blockdom
3233```
3334
34- ** CDN**
35+ Installing using Yarn:
36+ ```
37+ yarn add blockdom
38+ ```
3539
36- ``` js
40+ ### With a CDN
41+ ```
3742https://unpkg.com/blockdom@{VERSION}/dist/blockdom.iife.min.js
43+ ```
3844
39- // for the latest version
45+ For using the latest version:
46+ ```
4047https://unpkg.com/blockdom/dist/blockdom.iife.min.js
4148```
4249
50+
4351## Documentation
4452
4553- [ Reference documentation] ( doc/reference.md )
4654- [ Extending blockdom] ( doc/extending_blockdom.md )
4755- [ Performance Notes] ( doc/performance_notes.md )
4856- [ Tutorial: make your own framework] ( doc/make_your_own_framework/readme.md ) ([ chapter 1] ( doc/make_your_own_framework/part1.md ) , [ chapter 2] ( doc/make_your_own_framework/part2.md ) , [ chapter 3] ( doc/make_your_own_framework/part3.md ) , [ chapter 4] ( doc/make_your_own_framework/part4.md ) , [ chapter 5] ( doc/make_your_own_framework/part5.md ) , [ chapter 6] ( doc/make_your_own_framework/part6.md ) , [ conclusion] ( doc/make_your_own_framework/conclusion.md ) )
4957
58+
5059## Examples
5160
5261Instead of doing something like ` h('div', {}, [...some children]) ` , we can
@@ -134,6 +143,7 @@ const counterBlock = createBlock(`<button block-handler-1="click.capture">Increm
134143
135144The [ ` examples ` ] ( examples ) folder contains the complete code for this example.
136145
146+
137147## About this project
138148
139149In this section, you will find answers to some questions you may have about this
@@ -160,6 +170,7 @@ project.
160170 more. I genuinely want to improve this, and helpful criticism is always
161171 welcome.
162172
173+
163174## Credits
164175
165176` blockdom ` is inspired by many frameworks: snabbdom, then solid, ivi, stage0 and
0 commit comments