darkwiiplayer/nyooom
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Simplify readme

Browse source
This commit is contained in:
Talia 2025-02-18 15:42:20 +01:00
parent 611862d225
commit ce416d994b
1 changed files with 18 additions and 37 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
readme.md
View file

@ -1,44 +1,10 @@
# Nyooom
```js
import {html} from "nyooom/render.js"
import {html} from "nyooom/render"
import {ObservableValue} from "nyooom/observable"
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. `nyooom/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. `nyooom/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 nyooom should be able to read any code using it
and piece together what it does based on structure and function names
1. Nyooom should be easy to gradually introduce into an application that uses
a different framework or no framework at all
1. Nyooom 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.
This readme file may not reflect the latest state of the interface.**
## Overview
```js
const text = new State({value: "Nyooom is cool"})
const text = new ObservableValue("Nyooom is cool")
setTimeout(() => {text.value = "Nyooom is awesome!"}, 1e5)
document.body.append(html.div(
@ -48,6 +14,21 @@ document.body.append(html.div(
))
```
## Goals
> Arrakis teaches the attitude of the knife - chopping off what's incomplete and
> saying: "Now, it's complete because it's ended here."
>
> — Frank Herbert, Dune
Nyooom aims to offer as much convenienve as possible within the following
constraints:
1. Small, independent modules that can also work on their own
1. Code should be easy to figure out by someone who doesn't actiely use nyooom
1. Easy to gradually introduce and remove rather than forcing big re-writes
1. Flexible, hackable and easy to audit
## Importmaps
The included file `importmaps.html` can be used as a starting point for