@jinntec/fore 1.0.0-4 → 1.0.0-5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -6,7 +6,7 @@
6
6
  ![GitHub top language](https://img.shields.io/github/languages/top/jinntec/fore)
7
7
 
8
8
 
9
-
9
+ [Fore Element Reference](https://jinntec.github.io/Fore/doc/reference.html)
10
10
 
11
11
  ![logo](resources/images/light-200.png)
12
12
 
@@ -16,21 +16,22 @@
16
16
 
17
17
  ## [Demos Demos Demos Demos Demos](https://jinntec.github.io/Fore)
18
18
 
19
- Sorry for being loud - some people complaining not finding demos.
19
+ ^^^ Sorry for being loud - some people complaining not finding demos. ^^^
20
20
 
21
21
  > ATTENTION: Demos are out of sync with latest release. If you want latest and greatest checkout your local copy please. Demos will be updated
22
22
  > for final release.
23
23
 
24
- ## [Element Reference](https://jinntec.github.io/Fore/doc/reference.html)
25
-
26
24
  For latest and greatest please use a local installation. See 'Running demos and docs'
27
25
 
28
26
  # What it does
29
27
 
30
28
  Fore lets you write data-driven front-end applications in a declarative way
31
- just using HTML5 and JavaScript (ES6).
29
+ just using HTML5 Web Components.
32
30
 
33
31
  ![todo](resources/images/todo-screen.png)
32
+
33
+ [Source code](https://github.com/Jinntec/Fore/blob/960e093fadfbc96eb8514721fb7b53462567f1ec/demo/todo2.html) for above example just uses 53 lines of HTML.
34
+
34
35
  The use cases range from simple to complex forms to full single page
35
36
  applications. It can be used standalone or in conjunction with other web
36
37
  components or frameworks.
@@ -39,6 +40,21 @@ By using the bare metal of the browser
39
40
  platform, Fore integrates well with any other library you might want to use in
40
41
  conjunction with it.
41
42
 
43
+ ## Features
44
+
45
+ * implemented as vanilla web components in ES6
46
+ * fully descriptive - just HTML5
47
+ * MVC architecture
48
+ * state engine with dependency tracking for optimized updating
49
+ * lifecycle with detailed state events
50
+ * descriptive actions for data mutations (setvalue, insert, delete)
51
+ * multiple XML (or JSON) data instances
52
+ * group, repeat, dialog + switch container components
53
+ * generic UI control to bind any kind of control
54
+ * bound template expressions
55
+ * powerful XPath/XQuery 3.1 support in the browser
56
+ * Submission module declaratively wrapping the fetch API
57
+
42
58
 
43
59
  ## An xformish framework in Web Components
44
60
 
@@ -58,19 +74,6 @@ Being as close as possible to the web platform standards available in browsers n
58
74
  JS framework or component library.
59
75
 
60
76
 
61
- ## Features
62
-
63
- * MVC architecture
64
- * state engine with dependency tracking
65
- * fully descriptive
66
- * lifecycle with detailed state events
67
- * multiple XML (or JSON) data instances
68
- * group, repeat + switch container components
69
- * generic UI control to bind any kind of component
70
- * bound template expressions
71
- * powerful XPath/XQuery 3.1 support in the browser
72
- * Submission module declaratively wrapping the fetch API
73
-
74
77
  ## Framework-agnostic
75
78
 
76
79
  Fore focuses on providing a stable processing engine for model-driven
@@ -106,14 +109,20 @@ customize the wiring of the widget you use.
106
109
 
107
110
  More examples are found in the demos (see running)
108
111
 
112
+
109
113
  ## Documentation
110
114
 
111
- Currently the demos are the documentation (see 'demo' folder). All files listed on the demo.html page are expected to work
112
- and serve the purpose of documentation. The intend is to have at least one demo
113
- for each feature and show how to use it with an example.
115
+ ### Element Reference
116
+
117
+ The [Element Reference](https://jinntec.github.io/Fore/doc/reference.html) lists all exsting Fore elements (Web Components) in categories and documents their attributes. For each element one or more demos are linked
118
+ to see the element in action.
119
+
120
+ ### Demos
121
+ The demos are considered a major resource when it comes to learn how to use the featues (see 'demo' folder). All files listed on the demo.html page are expected to work and hopefully show the way to features and solutions.
114
122
 
115
123
  Some of them also offer some explanations and should give you an idea of building your own.
116
124
 
125
+
117
126
  ## Development and Contributions
118
127
 
119
128
  Default branch of development is 'dev'.