Skip to content

Commit 72fa90f

Browse files
committed
changed readme according to #63
1 parent 12b58a2 commit 72fa90f

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This repository collects information on email providers and their interoperabili
44

55
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.
66

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.
88

99

1010
## Format
@@ -14,7 +14,7 @@ The files build on this format:
1414
```yaml
1515
---
1616
name: [name of the provider]
17-
state: [OK or PREPARATION or BROKEN]
17+
status: [OK or PREPARATION or BROKEN]
1818
domains:
1919
- an_array
2020
- of_domains
@@ -35,29 +35,29 @@ after_login_hint: |
3535
Multiple lines are possible (line-breaks will be honoured).
3636
There's more room for text in the device chat than in the login form, but please keep the text concise nonetheless.
3737
]
38-
date: [optional: date when the information was last checked]
38+
last_checked: [optional: date when the information was last checked: YYYY-MM]
3939
website: [optional: website of the provider]
4040
---
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)]
4242
```
4343

4444
## Status options:
4545

4646
### OK
4747

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.
4949

5050
### PREPARATION
5151

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.
5353

5454
The required steps must be described as page content in a friendly, helpful howto-style.
5555

5656
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.
5757

5858
### BROKEN
5959

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.
6161

6262
The problems blocking the usage must be summarized as page content in a friendly tone.
6363

0 commit comments

Comments
 (0)