README Use collapsable sections

This make the FAQ section easier to read
This commit is contained in:
Benoit TELLIER
2021-09-24 16:44:44 +07:00
parent 449b512986
commit 2463ce5298
+15
View File
@@ -18,6 +18,8 @@ Here is how TMail looks like on a tablet:
### **Why did you choose JMAP?** ### **Why did you choose JMAP?**
<details>
<summary>Read more...</summary>
That is a good question! **IMAP** is THE ubiquitous protocol people use to read their emails, THE norm. That is a good question! **IMAP** is THE ubiquitous protocol people use to read their emails, THE norm.
Yet **IMAP** had been designed in another age, which resulted in a chatty patchwork of extensions. **IMAP** lacks decent synchronisation primitives to address real-time challenges modern mobile fleet requires, it consumes a lot of bandwith, requires a lot of roundtrips which means high latency. Yet **IMAP** had been designed in another age, which resulted in a chatty patchwork of extensions. **IMAP** lacks decent synchronisation primitives to address real-time challenges modern mobile fleet requires, it consumes a lot of bandwith, requires a lot of roundtrips which means high latency.
@@ -25,6 +27,7 @@ Yet **IMAP** had been designed in another age, which resulted in a chatty patchw
We are not alone to say this! Big players of the field started their own [proprietary](https://developers.google.com/gmail/api) [protocols](https://docs.microsoft.com/en-us/exchange/clients/exchange-activesync/exchange-activesync?view=exchserver-2019) to address IMAP flaws, and inter-operable standard was yet to be found... We are not alone to say this! Big players of the field started their own [proprietary](https://developers.google.com/gmail/api) [protocols](https://docs.microsoft.com/en-us/exchange/clients/exchange-activesync/exchange-activesync?view=exchserver-2019) to address IMAP flaws, and inter-operable standard was yet to be found...
This, is where **[JMAP](https://jmap.io/)** comes to play! **JMAP** builds on decades of experience, and beautifully addresses these challenges using `HTTP` and `JSON` standards. Not only does it make applications easier to develop, we also strongly believes it results in an improved experience for the end user. This, is where **[JMAP](https://jmap.io/)** comes to play! **JMAP** builds on decades of experience, and beautifully addresses these challenges using `HTTP` and `JSON` standards. Not only does it make applications easier to develop, we also strongly believes it results in an improved experience for the end user.
</details>
### **Can I use TMail with *any* JMAP server?** ### **Can I use TMail with *any* JMAP server?**
@@ -32,22 +35,30 @@ Yes, you can use the TMail application with any JMAP server and benefits from **
### **I don't understand your app... I need help using it! HELP MEEEEEE...** ### **I don't understand your app... I need help using it! HELP MEEEEEE...**
<details>
<summary>Read more...</summary>
Don't worry, we are here! Don't worry, we are here!
We plan on writing a user documentation, helping you navigating around the application, and detailing the few configurations you have to perform. We plan on writing a user documentation, helping you navigating around the application, and detailing the few configurations you have to perform.
If what you are looking for is not in the *user guide* then ask us directly in the [issues](https://github.com/linagora/tmail-flutter/issues) first, we would be glad to help. But also glad to improve our documentation and maybe tweak slightly our UI (user interface). If what you are looking for is not in the *user guide* then ask us directly in the [issues](https://github.com/linagora/tmail-flutter/issues) first, we would be glad to help. But also glad to improve our documentation and maybe tweak slightly our UI (user interface).
</details>
### **What plateforms do you (plan to) target?** ### **What plateforms do you (plan to) target?**
<details>
<summary>Read more...</summary>
First, we target Android, IOS mobiles. We also take care of tablets and large rendering space early on in the development process. First, we target Android, IOS mobiles. We also take care of tablets and large rendering space early on in the development process.
Then, we plan on introducing a desktop application. Then, we plan on introducing a desktop application.
This versatility is enabled by the use of the [Flutter framework](https://flutter.dev/). This versatility is enabled by the use of the [Flutter framework](https://flutter.dev/).
</details>
### **What would your roadmap look like?** ### **What would your roadmap look like?**
<details>
<summary>Read more...</summary>
First, we plan to write a simple, multi-plateform JMAP email client. This includes reading your mails and mailboxes, managing them, sending emails, searching your emails. This will likely keep us busy by the end of 2021. First, we plan to write a simple, multi-plateform JMAP email client. This includes reading your mails and mailboxes, managing them, sending emails, searching your emails. This will likely keep us busy by the end of 2021.
Then, we have plan for multiple features including: Then, we have plan for multiple features including:
@@ -59,6 +70,7 @@ Then, we have plan for multiple features including:
- Sending attachments via [LinShare]() file sharing platform. - Sending attachments via [LinShare]() file sharing platform.
- Transfering some attachments you received to [LinShare](https://www.linshare.org/fr/accueil/) file sharing platform. - Transfering some attachments you received to [LinShare](https://www.linshare.org/fr/accueil/) file sharing platform.
- Discussing some emails you received via [Twake](https://twake.app/en/) chat. - Discussing some emails you received via [Twake](https://twake.app/en/) chat.
</details>
### **Any chance to support JMAP extension for calendar, contacts?** ### **Any chance to support JMAP extension for calendar, contacts?**
@@ -66,6 +78,8 @@ No we do not plan to support such extensions, that are currently not standardize
### **Your work is awesome! I would like to help you. What can I do?** ### **Your work is awesome! I would like to help you. What can I do?**
<details>
<summary>Read more...</summary>
Thanks for the enthousiasm! Thanks for the enthousiasm!
There are many ways to help us, and amongst them: There are many ways to help us, and amongst them:
@@ -73,6 +87,7 @@ There are many ways to help us, and amongst them:
- **Spread the word**: Tell people you like **TMail**, on social medias, via blog posts etc... - **Spread the word**: Tell people you like **TMail**, on social medias, via blog posts etc...
- **Give us feedbacks**... It's hard to make all good decisions from the first time. It is very likely we can benefit from *your* experience. Did you encountered annoying bugs? Do you think we can better arrange the layout? Do you think we are missing some features critical to you? Tell us in the [issues](https://github.com/linagora/tmail-flutter/issues). - **Give us feedbacks**... It's hard to make all good decisions from the first time. It is very likely we can benefit from *your* experience. Did you encountered annoying bugs? Do you think we can better arrange the layout? Do you think we are missing some features critical to you? Tell us in the [issues](https://github.com/linagora/tmail-flutter/issues).
- I can code! **I wanna help ;-)**. Wow thanks! Let's discuss your project together in the [issues](https://github.com/linagora/tmail-flutter/issues) to get you on track! - I can code! **I wanna help ;-)**. Wow thanks! Let's discuss your project together in the [issues](https://github.com/linagora/tmail-flutter/issues) to get you on track!
</details>
### **Cool. I also want to write my own email application for JMAP. Can you help me?** ### **Cool. I also want to write my own email application for JMAP. Can you help me?**