@jinntec/fore 0.25.0 → 1.0.0-2

package/README.md

@@ -1,28 +1,54 @@
+![NPM](https://img.shields.io/npm/l/@jinntec/fore)
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/jinntec/fore/CI)
+![GitHub Discussions](https://img.shields.io/github/discussions/jinntec/fore)
+![GitHub last commit](https://img.shields.io/github/last-commit/jinntec/fore)
+![GitHub tag (latest SemVer)](https://img.shields.io/github/v/tag/jinntec/fore)
+![GitHub top language](https://img.shields.io/github/languages/top/jinntec/fore)
+
+
+
 
 ![logo](resources/images/light-200.png)
 
 >'situated in front of something else' - Merriam Webster
 
+[![Twitter URL](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2FJinnForeTec)](https://twitter.com/JinnForeTec) 
+
 ## [Demos](https://jinntec.github.io/Fore)
 
-DEMOS CURRENTLY OUTDATED AS OF 0.23.0 - WILL BE UPDATED SOONISH
+# What it does
 
-> Please note that not all demos are online as there are some technical obstacles still. If you don't want to miss 
-> new demos you should have your own clone running.
+Fore lets you write data-driven front-end applications in a declarative way
+just using HTML5 and JavaScript (ES6). 
 
-## An xformish forms framework in Web Components
+![todo](resources/images/todo-screen.png)
+The use cases range from simple to complex forms to full single page
+applications. It can be used standalone or in conjunction with other web 
+components or frameworks. 
 
-Fore is a model-driven forms framework that follows the ideas of the XForms 2.0
-Standard but translates those into the world of HTML5 Web Components.
+By using the bare metal of the browser
+platform, Fore integrates well with any other library you might want to use in
+conjunction with it.
 
-Fore uses XML as it's main data model but is intended to allow JSON alternatively or at the same time.
+
+## An xformish framework in Web Components
+
+Fore is a model-driven language that follows the ideas of the XForms 2.0
+Standard but applies those to the world of HTML5 Web Components.
+ 
+Going beyond just forms it nicely integrates with Web Components, allowing to configure, 
+ochestrate and interact with them by binding their properties to data instances.
+
+Fore uses XML as it's main data model but allows to use JSON alternatively or at the same time. Accessing and mutating JSON data with declarative
+actions makes JSON processing even easier than in native JavaScript.
 
 Through the wonderful [fontoXPath library](https://github.com/FontoXML/fontoxpath) Fore is able to process XML in the client with XPath 3.1 and 
 XQuery 3.1 support.
 
-Being as close as possible to the web platform standards available in browsers natively Fore combines well with any other 
+Being as close as possible to the web platform standards available in browsers natively, Fore combines well with any other 
 JS framework or component library.
 
+
 ## Features
 
 * MVC architecture 
@@ -34,11 +60,12 @@ JS framework or component library.
 * generic UI control to bind any kind of component 
 * bound template expressions
 * powerful XPath/XQuery 3.1 support in the browser
+* Submission module declaratively wrapping the fetch API
 
 ## Framework-agnostic
 
 Fore focuses on providing a stable processing engine for model-driven
-forms. Major premise for a longer-term solution is to stick closely to the features
+apps. Major premise for a longer-term solution is to stick closely to the features
 of the browser platform and avoid specific frameworks for the implementation.
 
 That said it's obvious that Fore does not provide a set of controls
@@ -46,7 +73,7 @@ by itself but allows you to use whatever uber-fancy components you have
 found elsewhere. May it be some material-design date-picker or 
 that nice jquery(sic!) timeline nobody has done better yet. 
 
-That comes to the price of slightly more markup up-front (working on it already)
+That comes to the price of slightly more markup up-front
 but allows big flexibility and makes it compatible with any framework
 that plays by the rules of the platform.
 
@@ -72,27 +99,42 @@ More examples are found in the demos (see running)
 
 ## Documentation
 
-Currently the demos are the documentation (see 'demo' folder). All files listed on the demo.html page are expected to work.
+Currently the demos are the documentation (see 'demo' folder). All files listed on the demo.html page are expected to work
+and serve the purpose of documentation. The intend is to have at least one demo
+for each feature and show how to use it with an example.
 
 Some of them also offer some explanations and should give you an idea of building your own.
 
-## Warning
+## Development and Contributions
 
-The project is still in it's prerelease phase. However there are already about 100 tests and what can be seen in demos is expected to work. The overall architecture matures quite nicely but certainly can still undergo some fundamental changes. There won't be any major releases before 1.0.0 so be aware of breaking changes (will annouce them). 
+Default branch of development is 'dev'.
+Feature additions or bugfixes will always there.
 
-It's expected that a first release will be available during this summer.
+The master branch is only used for releases. 
 
-## Development and Contributions
+Contributions are always welcome.  
 
-Contributions are always welcome. Default branch of development is 'dev'. PRs
-feature additions or bugfixes will always go into 'dev'.
+### what to contribute
 
-The master branch is only used for releases. 
+It's not all about code. 
 
-### Contributing demo forms
+Any feedback is welcome and appreciated. Please use the ['discussions'](https://github.com/Jinntec/Fore/discussions) or
+['issues'](https://github.com/Jinntec/Fore/issues) as appropriate to suggest features or ask your questions.
 
-There is a file called `demo/sample.html` which can be used to quickly write new demos. See below under 'Developing' for the required setup.
+New demo files are highly welcome as always something new can be learned. 
+There is a directory called 'template' that contains some blueprints that can be copied to quickly get going.
 
+When working on demos it is recommended to copy your file to the 'demo' folder
+and make it work there. If you have additional files you can create
+a subdirectory for the new demo.
+
+## Running from CDN
+
+Include the following snippet at end of body:
+
+```
+<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/@jinntec/fore@latest/dist/fore-all.js"></script>
+```
 ## Installation
 
 Run
@@ -118,7 +160,6 @@ If you intend to hack it yourself ...
 * clone this repo to your machine
 * run `npm i` to install dependencies
 
-
 ## Running demos and docs
 
 1. checkout this repo or download the sources
@@ -152,6 +193,18 @@ The package is still huge but is expected to shrink massively.
 Include the repective bundle in your webpage with a module import:
 ```
 <script type="module">
-    import 'fore-all.js';
+    import 'dist/fore-all.js';
 </script>
 ```
+
+## Giant shoulders
+
+The giants that made Fore possible:
+
+* past and current [XForms editors](https://www.w3.org/community/xformsusers/wiki/XForms_2.0) - not all brilliant ideas get traction and fame. Nevertheless a brilliantly worked out state engine.
+* [fontoXPath](https://github.com/FontoXML/fontoxpath) - without this wonderful XPath 3.1 implementation in the browser Fore has never been possible - period.
+* [depGraph](https://github.com/jriecken/dependency-graph) - finding this gem saved a big bunch of work. 
+
+Thanks to all giants!
+
+