Bladeren bron

Merge pull request #159 from deltachat/update-readme

Update readme
björn petersen 6 jaren geleden
bovenliggende
commit
d9b41300f4

+ 6 - 93
README.md

@@ -2,19 +2,17 @@
 
 >  Email-based instant messaging for iOS.
 
-
-
-![Screenshot Chat List](supporting_images/screenshot_chat_list.png) ![Screenshot Chat View](supporting_images/screenshot_chat_view.png)
+![Screenshot Chat List](docs/images/screenshot_chat_list.png) ![Screenshot Chat View](docs/images/screenshot_chat_view.png)
 
 ## Testing
 
 Betas are distributed via Testflight. Just scan this QR code with the camera app of your iPhone/iPad
 
-![QRCode](supporting_images/deltachat_testflight_qrcode.png)
+<img src=https://delta.chat/assets/home/deltachat_testflight_qrcode.png width=160>
 
 or open this link
 
-https://testflight.apple.com/join/WVoYFOZe
+https://testflight.apple.com/join/uEMc1NxS
 
 on your iPhone or iPad to try Deltachat iOS Beta.
 
@@ -35,94 +33,9 @@ $ open deltachat-ios.xcworkspace # do not: open deltachat-ios.xcodeproj
 
 This should open Xcode. Then make sure that at the top left in Xcode there is *deltachat-ios* selected as scheme (see screenshot below).
 
-![Screenshot](supporting_images/screenshot_scheme_selection.png)
+![Screenshot](docs/images/screenshot_scheme_selection.png)
 
 Now build and run - e.g. by pressing Cmd-r - or click on the triangle at the top:
 
-![Screenshot](supporting_images/screenshot_build_and_run.png)
-
-## Roadmap / TODO for 'minimal viable version'
-
-- [X] use new deltachat-core-api and
- adapt threads to the following scheme:
- https://deltachat.github.io/api/
- (the current ios-implementation relies on
- threads created by deltachat-core; this is no longer done)
-- [X] threads should be created when going to foreground
- and removed when going to background.
- we could say, for the first version, we're a foreground app
- and figure out background things later
-- [X] order: new group, new contact
-- [X] allow group creation (leave out group settings
-      and settings for contact for now)
-- [X] text drafts support
-- [X] support DC_EVENT_HTTP_GET event
-- [X] add a progress indicator while doing the configuration
-- [X] allow advanced configuration options on setup
-      to make sure users can connect if the autoconfig fails
-      (imap-server, imap-port, imap-flags, same for smtp)
-- [X] allow re-configuring (e.g. after changing the IMAP/SMTP password) at
-      an arbitrary point in time
-- [X] allow sending of images
-      and taking+sending photos directly from the camera.
-      (videos and voice messages
-      and other attachments can be done in a later version)
-- [x] reception of images
-- [ ] ui-polishing, eg.
-  - [x] improve group creation UI
-  - [ ] smarter time/date display
-    (time beside messages, date as headlines)
-  - [x] adapt avatars (use the colored images from the chatlist
-    also in the chat, no avatars beside outgoing messages
-  - [x] show e-mail-address in the chat-title and/or open profile
-    when clicking on chat-title
-    (subtitle) dc_chat_get_subtitle
-- [x] read address book for contact suggestions
-- [ ] check notifications, currently there is only a vibrate,
-      however, we should keep in mind that the first version
-      may be a "foreground" app, so "system notifications" may
-      be delayed to a later version
-- [ ] check how to solve this: new messages are only seen if a chat is closed and shown again (similar to that). No tune, no number at icon. https://github.com/deltachat/deltachat-ios/issues/9#issue-356157986
-
-
-## Changelog (for TestFlight builds)
-
-### Beta 7
-2019-01-21
-
-- include everything up to https://github.com/deltachat/deltachat-ios/commit/9e558bae0b99a8204422f257ad3071f40c0b668e on master.
-
-### Beta 6
-2019-01-08
-
-- include work from merged PRs: https://github.com/deltachat/deltachat-ios/pull/30 , https://github.com/deltachat/deltachat-ios/pull/17 , and https://github.com/deltachat/deltachat-ios/pull/16
-
-### Beta 5
-2018-10-01
-
-- allow advanced configuration options on setup to make sure users can connect if the autoconfig fails (imap-server, imap-port, imap-flags, same for smtp)
-
-### Beta 4
-2018-09-18
-
-- display last DC_EVENT_ERROR string upon configuration failure
-
-### Beta 3
-2018-09-17
-
-- support automatic configuration via DC_EVENT_HTTP_GET event
-- progress indicator while doing the configuration
-- fixes iPad crash
-
-### Beta 2
-2018-07-26
-
-- new deltachat-core-api (no more polling, much faster)
-- groups can be created
-- text drafts support
-
-### Beta 1
-2018-06-11
-
-- UI: colored initial circles
-- screens and menus now more closely resemble the Android version, while staying true to iOS conventions
+![Screenshot](docs/images/screenshot_build_and_run.png)
+

+ 0 - 0
supporting_images/screenshot_build_and_run.png → docs/images/screenshot_build_and_run.png


+ 0 - 0
supporting_images/screenshot_chat_list.png → docs/images/screenshot_chat_list.png


+ 0 - 0
supporting_images/screenshot_chat_view.png → docs/images/screenshot_chat_view.png


+ 0 - 0
supporting_images/screenshot_scheme_selection.png → docs/images/screenshot_scheme_selection.png


BIN
supporting_images/deltachat_testflight_qrcode.png