diff --git a/README.md b/README.md index c4b0954..eea3c53 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,8 @@ # LEGO: Modern Web-Components +LEGO (_Lightweight Embedded Gluten-free Objects_) is a base class that you extend and provide you with methods to use ♻️ reactive and 🏑 **native web-components** that are easy to digest 🌱 for your browser. + ## Native Web-Components? Yes, you write native HTML, CSS and JS and create a native web-components [W3C](https://en.wikipedia.org/wiki/World_Wide_Web_Consortium) compliant. @@ -14,7 +16,7 @@ It's stable and predictable. If you have ever played with Web-Component-like frameworks (not to name Vue, React, Svelte…), you may know how debugging gets tricky and requires extra tooling. -Because LEGO is native, your browser developper toobar is all you need. +Because LEGO is native, your browser developer toolbar is all you need. - `debugger` works as expected, - _step-by-step_ debugging, - element inspector, @@ -85,12 +87,12 @@ There's no [Vite](https://vitejs.dev/) nor other 3rd parties, it's [just an inte ## What is LEGO Behind? - πŸ‘™ Minimalist: ~74~ 61 lines of readable code in its core (non-optimised, uncompressed, no cheating) -- 🌱 Zero dependency: it uses [Petit-Dom](https://github.com/yelouafi/petit-dom) which is stable and embedded, so no bad suprise in the future +- 🌱 Zero dependency: it uses [Petit-Dom](https://github.com/yelouafi/petit-dom) which is stable and embedded, so no bad surprise in the future - ♻️ Reactive: updating the state recalculate the Virtual Dom when needed - πŸš€ fast: using virtual dom through a thin layer makes it close to bare-metal - πŸ’§ Simple: that's [Vanilla](http://vanilla-js.com/), there isn't much to know, it's a raw class to extend; no magic ✨ - πŸͺΆ 3 directives to enhance HTML: `:if` for conditions, `:for` for loops, `@myfuncname` to call an action -- 🏑 Native: LEGO components are actual native web-components, you benefit from all the today's and tomorrow's possibilites ([slot](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_templates_and_slots), [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM), …). +- 🏑 Native: LEGO components are actual native web-components, you benefit from all the today's and tomorrow's possibilities ([slot](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_templates_and_slots), [Shadow DOM](https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_shadow_DOM), …). Lego is not (and will never be): - 🏯 A full bloated frontend framework with routing. [Others do it well](https://github.com/visionmedia/page.js). @@ -107,4 +109,4 @@ Lego is not (and will never be): πŸ”§ Customizing and contributing is just **much lighter** with simplicity, source that are easy to read, to hack and to maintain. -🎈 You can [read the core code](https://github.com/Polight/lego/blob/master/src/lib/Component.js) that is only 61 LOC resulting that Lego is **as light as 3Kb** for the full bundle! +🎈 You can [read the core code](https://github.com/Polight/lego/blob/master/src/lib/Component.js) that is only 61 LOC resulting that Lego is **as light as 3kb** for the full bundle! diff --git a/docs/20-usage.md b/docs/20-usage.md index 1e134c2..19cca01 100644 --- a/docs/20-usage.md +++ b/docs/20-usage.md @@ -16,7 +16,7 @@ has_children: true A web-component can optionally have 3 parts: some HTML in a `