diff --git a/draft/w30-user-guide.md b/draft/w30-user-guide.md new file mode 100644 index 000000000..686513252 --- /dev/null +++ b/draft/w30-user-guide.md @@ -0,0 +1,123 @@ +# W30 User Guide + +## W30 File Format + +- a **W30** app is a **ZIP-file** with the extension `.w30` +- the ZIP-file must contain at least the file `index.html` +- if the W30 app is started, `index.html` is opened in a restricted webview + that allow accessing resources only from the ZIP-file + + +## W30 API + +W30 apps can do anything that is allowed in webviews - +html, css, images, canvas, javascript and so on. + +There are some additional APIs available once `deltachat.js` is included +(the file will be provided by the concrete implementations, +no need to add `deltachat.js` to your ZIP-file): + +``` + + + + + Send +

+ + + +``` + +For a more advanved example, see https://github.com/r10s/w30-poll/ . + + +## Closing Remarks + +- older devices might not have the newest js features in their webview, + you may want to transpile your code down to an older js version eg. with https://babeljs.io +- there are tons of ideas for enhancements of the API and the file format, + eg. in the future, we will may define icon- and manifest-files, + allow to aggregate the state or add metadata. \ No newline at end of file