diff --git a/.changeset/major-clocks-cheer.md b/.changeset/major-clocks-cheer.md new file mode 100644 index 0000000000..a845151cc8 --- /dev/null +++ b/.changeset/major-clocks-cheer.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/lib/model/common/README.md b/lib/model/common/README.md new file mode 100644 index 0000000000..fe71d24f1b --- /dev/null +++ b/lib/model/common/README.md @@ -0,0 +1,15 @@ +# What is it for? + +The purpose of this package is to keep primitives and functions, that have to be shared between all our execution contexts: + +- node +- quickjs sandbox +- browser +- browser preload + +We have code that can work in a single specific context (like UI of the block) or in a mixture of contexts. + +This package is a meeting point for code that can exist in all possible places. + +- NEVER put context-dependent code here. This may (and probably will) ruin the build in some other place (i.e. Desktop App). +- Keep list of dependencies limited and clear. Each new dependency is a moment to think wether you really need it.