From d33b6fd177a1e68cb10d9c76ae7756c068231e22 Mon Sep 17 00:00:00 2001 From: DarkWiiPlayer Date: Fri, 2 Aug 2024 09:24:50 +0200 Subject: [PATCH] Add code example and goals section in readme --- readme.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index 6685c7a..8ed9f97 100644 --- a/readme.md +++ b/readme.md @@ -1,12 +1,35 @@ # Skooma -A functional-friendly helper library for procedural DOM generation and -templating. - ```js -import {html} from "skooma/state.js" +import {html} from "skooma/render.js" + +document.body.append( + html.p( + "This is a paragraph with some text ", + html.b("and some bold text "), + html.img({ + alt: "And an image", + href: "http://picsum.photos/200/200" + }) + ) +) ``` +## Goals + +1. `skooma/render` should stay small enough to use it as just a helper library + to generate some dom nodes in any sort of web environment. +1. `skooma/observable` should likewise function as a standalone reactive state + management library to be used with or without a framework +1. A developer who doesn't use skooma should be able to read any code using it + and piece together what it does based on structure and function names +1. Skooma should be easy to gradually introduce into an application that uses + a different framework or no framework at all +1. Skooma should make it easy to gradually replace it with a different solution + should it prove unfit for a project it is being used in +1. The library should be hackable so that developers can tweak it for different + environments like SSR or frameworks + ## Warning **This branch is in the process of being aggressively refactored and improved.