chore: commit save point

486a6bf5 · Volker Schukai · c103f399 · 486a6bf5 · 486a6bf5 · 486a6bf5
Verified Commit 486a6bf5 authored 2 years ago by Volker Schukai
--- a/README.md
+++ b/README.md
 # Monster

-A modern, efficient and flexible JavaScript library for building user interfaces.
-
-Monster relies on proven concepts mixed with many new JavaScript concepts.
+Monster is perfectly suited for the creation of beautiful and fast  
+user interfaces and websites.

-The library relies on modern features such as classes, WeakRef,
-WeakMaps, proxies or the MutationObserver interface, to name a few.
+Monster relies on proven concepts mixed with many new JavaScript concepts such as 
+classes, WeakRef, WeakMaps, proxies or the MutationObserver interface, just to name a few.

-Monster integrates easily into your existing websites without taking over
-everything.
+Monster integrates easily into your existing websites without taking over everything.

 It is not the goal of Monster to pull in an entirely new abstraction
 with its own language, but to combine the existing techniques of HTML,  
 CSS and JavaScript in a meaningful way.

-Monster is perfectly suited for the creation of beautiful and fast  
-user interfaces and websites. The basis is formed by core functions that  
-can be supplemented by necessary classes and objects.
-
 One design target is to reach the shiny sun with as little JavaScript as possible.

 Monster was built with ES6 modules and uses [import](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Statements/import)  
@@ -33,6 +27,45 @@ To check out docs and examples, visit [monsterjs.org/en/doc/monster/](https://mo

 `npm install @schukai/monster`, `yarn install @schukai/monster` or `pnpm install @schukai/monster`

+## Usage
+
+A simple example of the use of functionality from Monster. We create a small file `index.mjs`.
+The `m` in `.mjs` stands for module. In the example we want to make substitutions in a string.
+
+```js
+import {Formatter} from '@schukai/monster/source/text/formatter.mjs';
+const text = '${mykey${subkey}}';
+let obj = {
+    mykey2: "1",
+    subkey: "2"
+};
+
+new Formatter(obj).format(text);
+// ↦ 1
+```
+
+To integrate this function into a website it is recommended to use a bundler like [esbuild](https://esbuild.github.io/).
+
+```sh
+esbuild index.mjs --outfile dist.js
+```
+
+We can now integrate that into our website.
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>Monster</title>
+    <script src="dist.js"></script>
+</head>
+<body>
+```
+
+Voila!
+
+
 ### Polyfill

 We do try to work around some browser bugs, but on the whole we don't use polyfills and feature detection.

--- a/application/source/constants.mjs
+++ b/application/source/constants.mjs
-'use strict';
+

 /**
 * Property-Keys

--- a/application/source/constraints/abstract.mjs
+++ b/application/source/constraints/abstract.mjs
-'use strict';
-
-/**
- * @author schukai GmbH
- */
-
+// Copyright schukai GmbH and contributors 2022. All Rights Reserved.
+// Node module: @schukai/monster
+// This file is licensed under the AGPLv3 License.
+// License text available at https://www.gnu.org/licenses/agpl-3.0.en.html

 import {Base} from '../types/base.mjs';

@@ -16,7 +14,7 @@ export {AbstractConstraint}
 * 
 * The abstract constraint defines the api for all constraints. mainly the method isValid() is defined.
 *
- * derived classes must implement the method isValid().
+ * Derived classes must implement the method isValid().
 *
 * @since 1.3.0
 * @copyright schukai GmbH

--- a/application/source/constraints/abstractoperator.mjs
+++ b/application/source/constraints/abstractoperator.mjs
-'use strict';
+

 /**
 * @author schukai GmbH

--- a/application/source/constraints/andoperator.mjs
+++ b/application/source/constraints/andoperator.mjs
-'use strict';
+

 /**
 * @author schukai GmbH

--- a/application/source/constraints/invalid.mjs
+++ b/application/source/constraints/invalid.mjs
-'use strict';
+

 /**
 * @author schukai GmbH

--- a/application/source/constraints/isarray.mjs
+++ b/application/source/constraints/isarray.mjs
-'use strict';
+

 /**
 * @author schukai GmbH

--- a/application/source/constraints/isobject.mjs
+++ b/application/source/constraints/isobject.mjs
-'use strict';
+

 /**
 * @author schukai GmbH

--- a/application/source/constraints/namespace.mjs
+++ b/application/source/constraints/namespace.mjs
-'use strict';
+

 /**
 * Constraints are used to define conditions that must be met by the value of a variable so that the value can be transferred to the system.

--- a/application/source/constraints/oroperator.mjs
+++ b/application/source/constraints/oroperator.mjs
-'use strict';
+

 /**
 * @author schukai GmbH

--- a/application/source/constraints/valid.mjs
+++ b/application/source/constraints/valid.mjs
-'use strict';
+

 /**
 * @author schukai GmbH

--- a/application/source/data/buildmap.mjs
+++ b/application/source/data/buildmap.mjs
-'use strict';
+

 /**
 * @author schukai GmbH

--- a/application/source/data/buildtree.mjs
+++ b/application/source/data/buildtree.mjs
-'use strict';
+

 /**
 * @author schukai GmbH

--- a/application/source/data/datasource.mjs
+++ b/application/source/data/datasource.mjs
-'use strict';
+

 /**
 * @author schukai GmbH

--- a/application/source/data/datasource/namespace.mjs
+++ b/application/source/data/datasource/namespace.mjs
-'use strict';
+

 /**
 * Namespace for datasources

--- a/application/source/data/datasource/restapi.mjs
+++ b/application/source/data/datasource/restapi.mjs
-'use strict';
+

 /**
 * @author schukai GmbH

--- a/application/source/data/datasource/restapi/namespace.mjs
+++ b/application/source/data/datasource/restapi/namespace.mjs
-'use strict';
+

 /**
 * Namespace for storages

--- a/application/source/data/datasource/restapi/writeerror.mjs
+++ b/application/source/data/datasource/restapi/writeerror.mjs
-'use strict';
+

 /**
 * @author schukai GmbH

--- a/application/source/data/datasource/storage.mjs
+++ b/application/source/data/datasource/storage.mjs
-'use strict';
+

 /**
 * @author schukai GmbH

--- a/application/source/data/datasource/storage/localstorage.mjs
+++ b/application/source/data/datasource/storage/localstorage.mjs
-'use strict';
+

 /**
 * @author schukai GmbH