Update readme (#264)

getodk · Dec 17, 2024 · 6b2ad27 · 6b2ad27
1 parent dfc6c70
commit 6b2ad27
Show file tree

Hide file tree

Showing 2 changed files with 38 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 With ODK Web Forms, you can define forms with powerful logic using the spreadsheet-based [XLSForm standard](https://docs.getodk.org/xlsform/). Use [our Vue-based frontend](/packages/web-forms/) or build your own user experience around [the engine](/packages/xforms-engine/)!
 
+You can try a preview [on the ODK website](https://getodk.org/web-forms-preview/).
+
 > [!IMPORTANT]
 > ODK Web Forms is currently pre-release. We don't yet guarantee that its interfaces are stable and it is missing many features that are available in XLSForm form definitions.
 
@@ -18,6 +20,8 @@ https://github.com/getodk/web-forms/assets/447837/9b25e1bc-d209-462c-8e9e-3259bd
 - [scenario](/packages/scenario): engine client used to express tests on forms
 - [ui-solid](/packages/ui-solid): form-filling frontend built with Solid, likely not as up-to-date as the Vue client
 
+Run the preview with `yarn workspace @getodk/web-forms dev`.
+
 ## Project status
 
 ODK Web Forms is developed by the [ODK team](https://getodk.org/).
@@ -42,19 +46,20 @@ This section is auto generated. Please update `feature-matrix.json` and then run
   <summary>
 
 <!-- prettier-ignore -->
-  #####  $\texttt{Question types (basic functionality)\hspace{5mm}\color{green}██\color{LightGray}█████████████ \color{initial} 18\\%}$
+  #####  $\texttt{Question types (basic functionality)\hspace{5mm}\color{green}████\color{LightGray}███████████ \color{initial} 29\\%}$
 
   </summary>
   <br/>
 
 | Feature <img width=250px/> | Progress |
 | -------------------------- | :------: |
 | text                       |    ✅    |
-| integer                    |          |
-| decimal                    |          |
+| integer                    |    ✅    |
+| decimal                    |    ✅    |
 | note                       |    ✅    |
 | select_one                 |    ✅    |
 | select_multiple            |    ✅    |
+| select\_\*\_from_file      |    ✅    |
 | repeat                     |    ✅    |
 | group                      |    ✅    |
 | geopoint                   |          |
@@ -72,7 +77,7 @@ This section is auto generated. Please update `feature-matrix.json` and then run
 | time                       |          |
 | datetime                   |          |
 | rank                       |          |
-| csv-external               |          |
+| csv-external               |    ✅    |
 | acknowledge                |    🚧    |
 | start                      |          |
 | end                        |          |
@@ -89,18 +94,18 @@ This section is auto generated. Please update `feature-matrix.json` and then run
   <summary>
 
 <!-- prettier-ignore -->
-  #####  $\texttt{Appearances\hspace{41mm}\color{green}███\color{LightGray}████████████ \color{initial} 24\\%}$
+  #####  $\texttt{Appearances\hspace{41mm}\color{green}████\color{LightGray}███████████ \color{initial} 28\\%}$
 
   </summary>
   <br/>
 
 | Feature <img width=250px/> | Progress |
 | -------------------------- | :------: |
-| numbers                    |          |
+| numbers                    |    ✅    |
 | multiline                  |          |
 | url                        |          |
 | ex:                        |          |
-| thousands-sep              |          |
+| thousands-sep              |    ✅    |
 | bearing                    |          |
 | vertical                   |          |
 | no-ticks                   |          |
@@ -137,6 +142,7 @@ This section is auto generated. Please update `feature-matrix.json` and then run
 | label                      |    ✅    |
 | list-nolabel               |    ✅    |
 | list                       |    ✅    |
+| counter                    |          |
 
 </details>
 
@@ -193,28 +199,27 @@ This section is auto generated. Please update `feature-matrix.json` and then run
   <summary>
 
 <!-- prettier-ignore -->
-  #####  $\texttt{Descriptions and Annotations\hspace{14mm}\color{green}███\color{LightGray}████████████ \color{initial} 20\\%}$
+  #####  $\texttt{Descriptions and Annotations\hspace{14mm}\color{green}███\color{LightGray}████████████ \color{initial} 21\\%}$
 
   </summary>
   <br/>
 
-| Feature <img width=250px/>                     | Progress |
-| ---------------------------------------------- | :------: |
-| label                                          |    ✅    |
-| hint                                           |    ✅    |
-| guidance hint                                  |          |
-| Translations                                   |    ✅    |
-| Translations with field/question value         |          |
-| Markdown                                       |          |
-| Inline HTML                                    |          |
-| Form attachments                               |          |
-| image                                          |          |
-| big-image                                      |          |
-| audio                                          |          |
-| video                                          |          |
-| secondary instance (external choice file<br/>) |          |
-| secondary instance (last saved)                |          |
-| autoplay                                       |          |
+| Feature <img width=250px/>             | Progress |
+| -------------------------------------- | :------: |
+| label                                  |    ✅    |
+| hint                                   |    ✅    |
+| guidance hint                          |          |
+| Translations                           |    ✅    |
+| Translations with field/question value |          |
+| Markdown                               |          |
+| Inline HTML                            |          |
+| Form attachments                       |          |
+| image                                  |          |
+| big-image                              |          |
+| audio                                  |          |
+| video                                  |          |
+| secondary instance (last saved)        |          |
+| autoplay                               |          |
 
 </details>
 

diff --git a/feature-matrix.json b/feature-matrix.json
@@ -1,11 +1,12 @@
 {
   "Question types (basic functionality)": {
     "text": "✅",
-    "integer": "",
-    "decimal": "",
+    "integer": "✅",
+    "decimal": "✅",
     "note": "✅",
     "select_one": "✅",
     "select_multiple": "✅",
+    "select_*_from_file": "✅",
     "repeat": "✅",
     "group": "✅",
     "geopoint": "",
@@ -23,7 +24,7 @@
     "time": "",
     "datetime": "",
     "rank": "",
-    "csv-external": "",
+    "csv-external": "✅",
     "acknowledge": "🚧",
     "start": "",
     "end": "",
@@ -35,11 +36,11 @@
     "audit": ""
   },
   "Appearances": {
-    "numbers": "",
+    "numbers": "✅",
     "multiline": "",
     "url": "",
     "ex:": "",
-    "thousands-sep": "",
+    "thousands-sep": "✅",
     "bearing": "",
     "vertical": "",
     "no-ticks": "",
@@ -75,7 +76,8 @@
     "field-list": "✅",
     "label": "✅",
     "list-nolabel": "✅",
-    "list": "✅"
+    "list": "✅",
+    "counter": ""
   },
   "Parameters": {
     "randomize": "✅",
@@ -115,7 +117,6 @@
     "big-image": "",
     "audio": "",
     "video": "",
-    "secondary instance (external choice file)": "",
     "secondary instance (last saved)": "",
     "autoplay": ""
   },