Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lognaturel committed Dec 13, 2024
1 parent 0acbbc2 commit e12cba6
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 13 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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/).
Expand All @@ -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 | |
Expand All @@ -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 | |
Expand All @@ -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 | |
Expand Down Expand Up @@ -137,6 +142,7 @@ This section is auto generated. Please update `feature-matrix.json` and then run
| label ||
| list-nolabel ||
| list ||
| counter | |

</details>

Expand Down
14 changes: 8 additions & 6 deletions feature-matrix.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
{
"Question types (basic functionality)": {
"text": "",
"integer": "",
"decimal": "",
"integer": "",
"decimal": "",
"note": "",
"select_one": "",
"select_multiple": "",
"select_*_from_file": "",
"repeat": "",
"group": "",
"geopoint": "",
Expand All @@ -23,7 +24,7 @@
"time": "",
"datetime": "",
"rank": "",
"csv-external": "",
"csv-external": "",
"acknowledge": "🚧",
"start": "",
"end": "",
Expand All @@ -35,11 +36,11 @@
"audit": ""
},
"Appearances": {
"numbers": "",
"numbers": "",
"multiline": "",
"url": "",
"ex:": "",
"thousands-sep": "",
"thousands-sep": "",
"bearing": "",
"vertical": "",
"no-ticks": "",
Expand Down Expand Up @@ -75,7 +76,8 @@
"field-list": "",
"label": "",
"list-nolabel": "",
"list": ""
"list": "",
"counter": ""
},
"Parameters": {
"randomize": "",
Expand Down

0 comments on commit e12cba6

Please sign in to comment.