aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorChristian S <kriztan@users.noreply.github.com>2015-12-18 08:30:37 +0100
committerChristian S <kriztan@users.noreply.github.com>2015-12-18 08:30:37 +0100
commit43e1330e168bf5660862d309ae792228218c936a (patch)
tree53ace972c27e13fe588ff1c921309e035fa7edb6 /README.md
parent2e8c46981c3aafeb858b7fcaaef5c1c59ce79ae4 (diff)
changed app name in readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md57
1 files changed, 26 insertions, 31 deletions
diff --git a/README.md b/README.md
index bc7c44417..772427bdd 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,8 @@
-# Conversations
+# Pix-Art Messenger
-Conversations: the very last word in instant messaging
+Pix-Art Messenger is a fork of the official [Conversations](https://github.com/siacs/Conversations) app with some modifications described under features.
-This is a fork of the official [Conversations](https://github.com/siacs/Conversations) app with some modifications described under features.
-
-Conversations can be downloaded from github [releases](https://github.com/kriztan/Conversations/releases)
+Pix-Art Messenger can be downloaded from github [releases](https://github.com/kriztan/Conversations/releases)
![screenshots](https://raw.githubusercontent.com/siacs/Conversations/master/screenshots.png)
@@ -30,7 +28,7 @@ Conversations can be downloaded from github [releases](https://github.com/krizta
* Multiple accounts / unified inbox
* Very low impact on battery life
-our individual changes:
+our individual features:
* accounts are hard linked to pix-art.de
* increased avatar-sizes in account- and contact-details with prefering XMPP-avatars over addressbook avatars
* in-app self updater with dayly check for updates
@@ -40,13 +38,12 @@ our individual changes:
* images are transfered as JPEG
* support more file-types for file-transfer (pdf, doc, docx, txt, m4a, m4b, mp3, mp2, wav, aac, aif, aiff, aifc, mid, midi, 3gpp, avi, mp4, mpeg, mpg, mpe, mov, 3gp, apk, vcf, ics, zip, rar)
* show contacts name in locations shared in conferences
-* OpenPGP end-to-end encryption methode is disabled
### XMPP Features
-This Conversations works only with `pix-art.de`. However XMPP is an
+Pix-Art Messenger works only with `pix-art.de`. However XMPP is an
extensible protocol. These extensions are standardized as well in so called
-XEP's. Conversations supports a couple of these to make the overall user
+XEP's. Pix-Art Messenger supports a couple of these to make the overall user
experience better. Our XMPP-Server is prosody and supports all of the listed XEP's:
* [XEP-0065: SOCKS5 Bytestreams](http://xmpp.org/extensions/xep-0065.html) (or mod_proxy65). Will be used to transfer
@@ -61,10 +58,10 @@ experience better. Our XMPP-Server is prosody and supports all of the listed XEP
client to your desktop client and back within one conversation.
* [XEP-0237: Roster Versioning](http://xmpp.org/extensions/xep-0237.html) mainly to save bandwidth on poor mobile connections
* [XEP-0313: Message Archive Management](http://xmpp.org/extensions/xep-0313.html) synchronize message history with the
- server. Catch up with messages that were sent while Conversations was
+ server. Catch up with messages that were sent while Pix-Art Messenger was
offline.
* [XEP-0352: Client State Indication](http://xmpp.org/extensions/xep-0352.html) lets the server know whether or not
- Conversations is in the background. Allows the server to save bandwidth by
+ Pix-Art Messenger is in the background. Allows the server to save bandwidth by
withholding unimportant packages.
* [XEP-0363: HTTP File Upload](http://xmpp.org/extensions/xep-0363.html) allows you to share files in conferences and with offline
contacts. Requires an [additional component](https://github.com/siacs/HttpUploadComponent)
@@ -76,7 +73,7 @@ experience better. Our XMPP-Server is prosody and supports all of the listed XEP
* [Daniel Gultsch](https://github.com/inputmice)
-#### Head of Development (modified Conversations)
+#### Head of Development (Pix-Art Messenger)
* [Christian Schneppe](https://github.com/kriztan)
@@ -106,28 +103,28 @@ Translations for our own features are managed on github. If you would like to he
### General
-#### How do I install Conversations?
+#### How do I install Pix-Art Messenger?
-Conversations is entirely open source and licensed under GPLv3. So if you are a
+Pix-Art Messenger is entirely open source and licensed under GPLv3. So if you are a
software developer you can check out the sources from GitHub and use ant to
build your apk file.
-Our modified version of Conversation can be downloaded from github [releases](https://github.com/kriztan/Conversations/releases)
+Pix-Art Messenger can be downloaded from github [releases](https://github.com/kriztan/Conversations/releases)
#### How do I create an account?
-With our Conversations app you can only create and use accounts on `pix-art.de`. You can create your own account for free. You only need a nickname and a password. You don't need to add `@pix-art.de` to your nickname. After creating your own `pix-art.de` account you'll find me in your contact list. If you have any questions about our app or our service feel free to ask me or join our support-conference `support@room.pix-art.de`.
+With Pix-Art Messenger you can only create and use accounts on `pix-art.de`. You can create your own account for free. You only need a nickname and a password. You don't need to add `@pix-art.de` to your nickname. After creating your own `pix-art.de` account you'll find me in your contact list. If you have any questions about our app or our service feel free to ask me or join our support-conference `support@room.pix-art.de`.
#### How does the address book integration work?
-The address book integration was designed to protect your privacy. Conversations
+The address book integration was designed to protect your privacy. Pix-Art Messenger
neither uploads contacts from your address book to your server nor fills your
address book with unnecessary contacts from your online roster. If you manually
-add a Jabber ID to your phones address book Conversations will use the name and
+add a Jabber ID to your phones address book Pix-Art Messenger will use the name and
the profile picture of this contact. To make the process of adding Jabber IDs to
your address book easier you can click on the profile picture in the contact
-details within Conversations. This will start an "add to address book" intent
-with the JID as the payload. This doesn't require Conversations to have write
+details within Pix-Art Messenger. This will start an "add to address book" intent
+with the JID as the payload. This doesn't require Pix-Art Messenger to have write
permissions on your address book but also doesn't require you to copy/paste a
JID from one app to another.
@@ -167,23 +164,23 @@ everybody in your contact list to know that you have been using your computer at
In the past status has been used to judge the likelihood of whether or not your
messages are being read. This is no longer necessary. With Chat Markers
-(XEP-0333, supported by Conversations since 0.4) we have the ability to **know**
+(XEP-0333, supported by Pix-Art Messenger since 0.4) we have the ability to **know**
whether or not your messages are being read. Similar things can be said for
priorities. In the past priorities have been used (by servers, not by clients!)
to route your messages to one specific client. With carbon messages (XEP-0280,
-supported by Conversations since 0.1) this is no longer necessary. Using
+supported by Pix-Art Messenger since 0.1) this is no longer necessary. Using
priorities to route OTR messages isn't practical either because they are not
changeable on the fly. Metrics like last active client (the client which sent
the last message) are much better.
Unfortunately these modern replacements for legacy XMPP features are not widely
-adopted. However Conversations should be an instant messenger for the future and
-instead of making Conversations compatible with the past we should work on
+adopted. However Pix-Art Messenger should be an instant messenger for the future and
+instead of making Pix-Art Messenger compatible with the past we should work on
implementing new, improved technologies and getting them into other XMPP clients
as well.
Making these status and priority optional isn't a solution either because
-Conversations is trying to get rid of old behaviours and set an example for
+Pix-Art Messenger is trying to get rid of old behaviours and set an example for
other clients.
### Security
@@ -194,12 +191,12 @@ You can choose between different end-to-end encryption methodes, which are expla
#### Why are there three end-to-end encryption methods and which one should I choose?
-In most cases OTR should be the encryption method of choice. It works out of the box with most contacts as long as they are online. However, openPGP can, in some cases, (message carbons to multiple clients) be more flexible. Unlike OTR, OMEMO works even when a contact is offline, and works with multiple devices. It also allows asynchronous file-transfer when the server has [HTTP File Upload](http://xmpp.org/extensions/xep-0363.html). However, OMEMO is not as widely supported as OTR and is currently implemented only by Conversations. OMEMO should be preffered over OTR for contacts who use Conversations.
+In most cases OTR should be the encryption method of choice. It works out of the box with most contacts as long as they are online. However, openPGP can, in some cases, (message carbons to multiple clients) be more flexible. Unlike OTR, OMEMO works even when a contact is offline, and works with multiple devices. It also allows asynchronous file-transfer when the server has [HTTP File Upload](http://xmpp.org/extensions/xep-0363.html). However, OMEMO is not as widely supported as OTR and is currently implemented only by Pix-Art Messenger. OMEMO should be preffered over OTR for contacts who use Pix-Art Messenger.
#### How do I use OpenPGP
Before you continue reading you should note that the OpenPGP support in
-Conversations is experimental. This is not because it will make the app unstable
+Pix-Art Messenger is experimental. This is not because it will make the app unstable
but because the fundamental concepts of PGP aren't ready for widespread use.
The way PGP works is that you trust Key IDs instead of JID's or email addresses.
So in theory your contact list should consist of Public-Key-IDs instead of
@@ -209,8 +206,6 @@ downsides: It is vulnerable to replay attacks, it is rather verbose, and
decrypting and encrypting takes longer than OTR. It is however asynchronous and
works well with message carbons.
-In our version, OpenPGP is diabled because of the problems listed above.
-
To use OpenPGP you have to install the open source app
[OpenKeychain](http://www.openkeychain.org) and then long press on the account in
manage accounts and choose renew PGP announcement from the contextual menu.
@@ -221,12 +216,12 @@ For conferences the only supported encryption method is OpenPGP (OTR does not
work with multiple participants). Every participant has to announce their
OpenPGP key (see answer above). If you would like to send encrypted messages to
a conference you have to make sure that you have every participant's public key
-in your OpenKeychain. Right now there is no check in Conversations to ensure
+in your OpenKeychain. Right now there is no check in Pix-Art Messenger to ensure
that. You have to take care of that yourself. Go to the conference details and
touch every key id (The hexadecimal number below a contact). This will send you
to OpenKeychain which will assist you on adding the key. This works best in
very small conferences with contacts you are already using OpenPGP with. This
-feature is regarded experimental. Conversations is the only client that uses
+feature is regarded experimental. Pix-Art Messenger is the only client that uses
XEP-0027 with conferences. (The XEP neither specifically allows nor disallows
this.)