From 0a63e29026c68089b1bd5ded30672da6a89d9948 Mon Sep 17 00:00:00 2001 From: Paul Schaub Date: Sat, 7 Sep 2019 01:43:10 +0200 Subject: [PATCH] Add more information --- config.toml | 5 +- content/_index.md | 4 +- content/documentation/contribute.md | 25 ++++++++++ content/documentation/features.md | 62 ++++++++++++++++++++++++ content/documentation/getting_started.md | 7 +++ content/download.md | 11 +++++ 6 files changed, 110 insertions(+), 4 deletions(-) create mode 100644 content/documentation/contribute.md create mode 100644 content/documentation/features.md create mode 100644 content/documentation/getting_started.md create mode 100644 content/download.md diff --git a/config.toml b/config.toml index 4a63122..a9c92a9 100644 --- a/config.toml +++ b/config.toml @@ -5,8 +5,9 @@ theme = "hyde" [Menus] main = [ - {Name = "Source Code", URL = "https://codeberg.org/Mercury-IM/Mercury-IM"} - # {Name = "Download", URL = "https://example.com"} + {Name = "Documentation", URL = "/documentation"}, + {Name = "Source Code", URL = "https://codeberg.org/Mercury-IM/Mercury-IM"}, + {Name = "Download", URL = "/download"} ] [params] diff --git a/content/_index.md b/content/_index.md index 4b7f09e..52ff09b 100644 --- a/content/_index.md +++ b/content/_index.md @@ -12,9 +12,9 @@ You have the right to freedom! Mercury IM empowers you by granting you the 4 fre Thats why Mercury IM is licensed under the [GNU General Public License Version 3](https://www.gnu.org/licenses/gpl-3.0.en.html) or later to guarantee that it will forever be free software that respects your rights. -Furthermore Mercury IM does not try to lock you in in any way. If you don't like the app you deserve to be able to use something else without losing all your contacts. +Furthermore Mercury IM does not try to lock you in in any way. If you don't like the app you deserve to be able to use something else without losing all your contacts and messages. -For that reason Mercury IM did not reinvent the wheel but is build on top of the openly developed [XMPP protocol standard](https://xmpp.org/). That way the inner workings of the app are not kept a secret and everybody is able to build a compatible app. In fact, there is a wide range of compatible messenger apps for many platforms out there already! +For that reason Mercury IM did not reinvent the wheel but is build on top of the openly developed [XMPP protocol standard](https://xmpp.org/). That way the inner workings of the app are not kept a secret and everybody is able to build a compatible app to join the conversation. In fact, there is a wide range of [compatible messenger apps](https://xmpp.org/software/clients.html) for many platforms out there already! # Coming Soon! diff --git a/content/documentation/contribute.md b/content/documentation/contribute.md new file mode 100644 index 0000000..3d38ac5 --- /dev/null +++ b/content/documentation/contribute.md @@ -0,0 +1,25 @@ +--- +title: "Contribute" +date: 2019-09-07T01:25:37+02:00 +draft: true +--- + +You can help improving Mercury IM! + +## Translate + +Mercury IM is not available in your language? Change that by contributing translations! + +TODO: Translation Platform + +## Design + +Don't like the current launcher icon? Make a new one! If we like it, we may use it! + +TODO: More information + +## Code + +Join us over on [Codeberg.org](https://codeberg.org/Mercury-IM/) where Mercury IM is being developed. + +TODO: More information diff --git a/content/documentation/features.md b/content/documentation/features.md new file mode 100644 index 0000000..e45b30b --- /dev/null +++ b/content/documentation/features.md @@ -0,0 +1,62 @@ +--- +title: "Mercury Feature Support" +date: 2019-09-07T01:18:54+02:00 +draft: true +--- + +Mercury aims to be compliant to [RFC 6120: Extensible Messaging and Presence Protocol (XMPP)](https://tools.ietf.org/html/rfc6120). + + +## XEP Support +Mercury currently has explicit support for the following XEPs: + +* [XEP-0030: Service Discovery](https://xmpp.org/extensions/xep-0030.html) +* [XEP-0060: PubSub](https://xmpp.org/extensions/xep-0060.html) +* [XEP-0092: Software Version](https://xmpp.org/extensions/xep-0092.html) +* [XEP-0115: Entity Capabilities](https://xmpp.org/extensions/xep-0115.html) +* [XEP-0163: Personal Eventing Protocol](https://xmpp.org/extensions/xep-0163.html) +* [XEP-0198: Stream Management](https://xmpp.org/extensions/xep-0198.html) +* [XEP-0237: Roster Versioning](https://xmpp.org/extensions/xep-0237.html) +* [XEP-0280: Message Carbons](https://xmpp.org/extensions/xep-0280.html) +* [XEP-0352: Client State Indication](https://xmpp.org/extensions/xep-0352.html) +* [XEP-0359: Stable and Unique Stanza IDs](https://xmpp.org/extensions/xep-0359.html) (see [comments](#comments)) +* [XEP-0392: Consistent Color Generation](https://xmpp.org/extensions/xep-0392.html) + + +## Planned XEP Support +The following XEPs are on the TODO list: + +* [XEP-0045: Multi User Chats](https://xmpp.org/extensions/xep-0045.html) +* [XEP-0048: Bookmark Storage](https://xmpp.org/extensions/xep-0048.html) +* [XEP-0054: vcard-temp](https://xmpp.org/extensions/xep-0054.html) +* [XEP-0077: Inband Registration](https://xmpp.org/extensions/xep-0077.html) +* [XEP-0080: User Location](https://xmpp.org/extensions/xep-0080.html) (see [comments](#comments)) +* [XEP-0084: User Avatars](https://xmpp.org/extensions/xep-0084.html) (see [comments](#comments)) +* [XEP-0085: Chat State Notifications](https://xmpp.org/extensions/xep-0085.html) +* [XEP-0184: Message Delivery Receipts](https://xmpp.org/extensions/xep-0184.html) +* [XEP-0192: Blocking Command](https://xmpp.org/extensions/xep-0192.html) +* [XEP-0249: Direct MUC Invitations](https://xmpp.org/extensions/xep-0249.html) +* [XEP-0308: Last Message Correction](https://xmpp.org/extensions/xep-0308.html) +* [XEP-0313: Message Archive Management](https://xmpp.org/extensions/xep-0313.html) +* [XEP-0363: HTTP File Upload](https://xmpp.org/extensions/xep-0363.html) +* [XEP-0373](https://xmpp.org/extensions/xep-0373.html), [XEP-0374: OpenPGP for XMPP](https://xmpp.org/extensions/xep-0374.html) +* [XEP-0384: OMEMO Encryption](https://xmpp.org/extensions/xep-0384.html) +* [XEP-0394: Message Markup](https://xmpp.org/extensions/xep-0394.html) +* [XEP-0410: MUC Self-Ping](https://xmpp.org/extensions/xep-0410.html) +* [XEP-0420: Stanza Content Encryption](https://xmpp.org/extensions/xep-0420.html) + + +## Refused XEP Support +The following XEPs are *not* currently on the TODO list: + +* [XEP-0071: XHTML-IM](https://xmpp.org/extensions/xep-0071.html) (see [comments](#comments)) +* [XEP-0357: Push Notifications](https://xmpp.org/extensions/xep-0357.html) (see [comments](#comments)) + + +## Comments + +* XEP-0071: XEP is deprecated and considered a potential security risk +* XEP-0080: Presumably in form of an addon? +* XEP-0084: Work is currently done [upstream in Smack](https://github.com/igniterealtime/Smack/pull/332) +* XEP-0357: Mercury embraces decentralization and independence. This is not compatible with being functionally dependent on centralized push services. +* XEP-0359: Currently broken upstream, but a [fix](https://github.com/igniterealtime/Smack/pull/344) is submitted diff --git a/content/documentation/getting_started.md b/content/documentation/getting_started.md new file mode 100644 index 0000000..61f0069 --- /dev/null +++ b/content/documentation/getting_started.md @@ -0,0 +1,7 @@ +--- +title: "Getting Started" +date: 2019-09-07T01:13:02+02:00 +draft: true +--- + +Mercury IM is being developed using the XMPP client library [Smack](https://github.com/igniterealtime/Smack). diff --git a/content/download.md b/content/download.md new file mode 100644 index 0000000..518390d --- /dev/null +++ b/content/download.md @@ -0,0 +1,11 @@ +--- +title: "Download" +date: 2019-09-07T01:34:43+02:00 +draft: true +--- + +There are no downloads available yet :( + +## FDroid + +TODO: Link to FDroid repository.