You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ This repository collects information on email providers and their interoperabili
4
4
5
5
Parts of that information (the metadata, aka front matter) is included into the deltachat-core, to provides them to the Delta Chat apps on the different platforms.
6
6
7
-
The page's content is built into a web page that shows the state of the respective provider regarding its usage with Delta Chat, and details possibly required preparation steps, or explains why the interoperability is broken.
7
+
The page's content is built into a web page that shows the status of the respective provider regarding its usage with Delta Chat, and details possibly required preparation steps, or explains why the interoperability is broken.
8
8
9
9
10
10
## Format
@@ -14,7 +14,7 @@ The files build on this format:
14
14
```yaml
15
15
---
16
16
name: [name of the provider]
17
-
state: [OK or PREPARATION or BROKEN]
17
+
status: [OK or PREPARATION or BROKEN]
18
18
domains:
19
19
- an_array
20
20
- of_domains
@@ -35,29 +35,29 @@ after_login_hint: |
35
35
Multiple lines are possible (line-breaks will be honoured).
36
36
There's more room for text in the device chat than in the login form, but please keep the text concise nonetheless.
37
37
]
38
-
date: [optional: date when the information was last checked]
38
+
last_checked: [optional: date when the information was last checked: YYYY-MM]
39
39
website: [optional: website of the provider]
40
40
---
41
-
[Markdown-formatted content that gets displayed as provider-page on the web, linked from the apps (if state is not OK)]
41
+
[Markdown-formatted content that gets displayed as provider-page on the web, linked from the apps (if status is not OK)]
42
42
```
43
43
44
44
## Status options:
45
45
46
46
### OK
47
47
48
-
If the state is `OK`, a standard text is used as page content. You don't need to put in anything.
48
+
If the status is `OK`, a standard text is used as page content. You don't need to put in anything.
49
49
50
50
### PREPARATION
51
51
52
-
This state means that the user must do some preparing steps before they can use Delta Chat with their provider. For example enabling IMAP/SMTP at their provider's settings, or creating an app-specific password.
52
+
This status means that the user must do some preparing steps before they can use Delta Chat with their provider. For example enabling IMAP/SMTP at their provider's settings, or creating an app-specific password.
53
53
54
54
The required steps must be described as page content in a friendly, helpful howto-style.
55
55
56
56
Additionally a short, informative sentence must be written as `before_login_hint`, so tech-savy users already know what to do, and others get an idea what to expect from the linked provider page.
57
57
58
58
### BROKEN
59
59
60
-
This state means that Delta Chat will not work with this provider.
60
+
This status means that Delta Chat will not work with this provider.
61
61
62
62
The problems blocking the usage must be summarized as page content in a friendly tone.
0 commit comments