edited readme (#284)

* Update README.md * Update README.md * Update README.md * named to TelegramClient * moved tdlib section to wiki * Update README.md * moved badges * Changed Installation Guide so Windows tdlib works * Update README.md * Update README.md * Update README.md * Update README.md Co-authored-by: Freddy200 <[email protected]> Co-authored-by: Rohan Sawahn <[email protected]>
hpi-swa-teaching · Aug 6, 2020 · ea0d9ee · ea0d9ee
1 parent 528cc73
commit ea0d9ee
Showing 1 changed file with 51 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -1,17 +1,18 @@
 <p align="center"><img width="300" height="300" src="assets/logo.png" alt="TeleSqueak"></p>
 
-<h1 align="center" style=font-size:200px>TeleSqueak</h1>
+<h1 align="center" style=font-size:200px>TelegramClient</h1>
 
 <p align="center">
     <a href="https://github.com/hpi-swa-teaching/TelegramClient/commits/" title="Last Commit"><img src="https://img.shields.io/github/last-commit/hpi-swa-teaching/TelegramClient?style=flat"></a>
     <a href="https://github.com/hpi-swa-teaching/TelegramClient/issues" title="Open Issues"><img src="https://img.shields.io/github/issues/hpi-swa-teaching/TelegramClient"></a>
         <a href="https://github.com/hpi-swa-teaching/TelegramClient/actions?query=workflow%3ACI" title="Build Status - Master"><img src="https://img.shields.io/github/workflow/status/hpi-swa-teaching/telegramclient/CI/master?color=dwa&label=master&logo=dwa&logoColor=daw"></a>
     <a href="https://github.com/hpi-swa-teaching/TelegramClient/actions?query=workflow%3ACI" title="Build Status - Develop"><img src="https://img.shields.io/github/workflow/status/hpi-swa-teaching/telegramclient/CI/master?color=dwa&label=develop&logo=dwa&logoColor=daw"></a>
+    <img alt="Coveralls github branch" src="https://img.shields.io/coveralls/github/hpi-swa-teaching/TelegramClient/master?label=coverage%20-%20master">
+    <img alt="Coveralls github branch" src="https://img.shields.io/coveralls/github/hpi-swa-teaching/TelegramClient/develop?label=coverage%20-%20develop">
     <a href="./LICENSE" title="License"><img src="https://img.shields.io/github/license/hpi-swa-teaching/TelegramClient"></a>
-</p>
-
+
 ## Overview
-TeleSqueak is a **Squeak-Client** for the widely used Telegram-Messenger. It aims to provide features such as Authentication, Contacts, Message and Media sending and a minimal, clean UI as well as as a Zen-mode and receiving messages in the background.
+TelegramClient is a **Squeak-Client** for the widely used Telegram-Messenger. It aims to provide features such as Authentication, Contacts, Message and Media sending and a minimal, clean UI as well as as a Zen-mode and receiving messages in the background.
 
 *This Project is part of the "Softwaretechnik" Lecture 2020 at the Hasso Plattner Institute.*
 
@@ -21,24 +22,60 @@ Make sure you have the current version of Squeak installed.
 * Step 2: Install the Squeak FFI Workload. To do so, open the Workspace in Squeak and execute the following command:   `(Installer repository: 'http://source.squeak.org/FFI')
 install: 'FFI-Pools';
 install: 'FFI-Kernel'.`
-* Step 3: Download the required native Binaries for your system. [Windows](https://github.com/hpi-swa-teaching/tdlib/actions?query=workflow%3A%22Windows+CI%22), [Mac](https://github.com/hpi-swa-teaching/tdlib/actions?query=workflow%3A%22Tdlib+Max+x64+Build%22), [Ubuntu 18 lts](https://github.com/hpi-swa-teaching/tdlib/actions?query=workflow%3A%22Tdlib+Ubuntu+Build%22). Select the latest successful run of the pipeline and download the single artifact produced by the respective pipeline.
-* Step 4: Place the unzipped binaries inside of your squeak image inside the 'Resource' folder.
+* Step 3: Downloading the required native TDLib Binaries for your system: This should happen automatically. Alternatively you can download them here: On Windows you have to download [tdlib_windows.zip](https://github.com/hpi-swa-teaching/tdlib). For [Ubuntu 18 lts](https://github.com/hpi-swa-teaching/tdlib/actions?query=workflow%3A%22Tdlib+Ubuntu+Build%22) select the latest successful run of the pipeline and download the single artifact produced by the respective pipeline. We currently don't support MacOS yet, to find out more about this check our [wiki](https://github.com/hpi-swa-teaching/TelegramClient/wiki/Difficulties-and-Tips).
+* Step 4 (Manual download only): Place the unzipped binaries inside of your squeak image inside the 'Resource' folder.
 * Step 5 (Windows only): Install the [Visual C++ Redistributable for Visual Studio 2015, 2017 and 2019](https://aka.ms/vs/16/release/vc_redist.x64.exe)
 
 Alternatively, check our [release page](https://github.com/hpi-swa-teaching/TelegramClient/releases) for an online installer in the form of a sar file. In that case you just have to follow steps two and five.
 ## Running TelegramClient
 In a workspace window either execute the command `TCUTelegram newWithTCCCore` or click the Telegram entry in the Apps dropdown menu. The menu is only available if you already started the app once or installed the app via a release sar file.
 
-## Building Tdlib
-Tdlib build instructions are available on their Github page. They also have a wonderful build instruction generator available which was the basis for our workflow . [Check it out here.](https://tdlib.github.io/td/build.html) Alternatively use the [Github Pipelines](https://github.com/hpi-swa-teaching/tdlib) we setup and modify them according to newer build instructions for successive tdlib versions. Currently we release at Tag 1.6.0.
-
-## Notes on Tdlib
-The TelegramClient is build on the TelegramDatabseLibrary which provides access to Telegram API via a JSON-Interface.
-We include Tdlib in our project and can access it with the Squeak FFI, in turn allowing us to access the Telegram API via JSON-Interface.
-Once this project concludes there will be a need for the next group to aquire a new [API key](https://core.telegram.org/api/obtaining_api_id).
+## Features
+<table>
+  <thead>
+    <tr>
+      <th>✨</th>
+      <th>Feature</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>🔓</td>
+      <td>Authenticate yourself in TeleSqueak via Telegram</td>
+    </tr>
+    <tr>
+      <td>✉️</td>
+      <td>Send messages to other users</td>
+    </tr>
+    <tr>
+      <td>💬</td>
+      <td>Display open Chats in a List</td>
+    </tr>
+    <tr>
+      <td>📫</td>
+      <td>Receive messages</td>
+    </tr>
+    <tr>
+      <td>🆕</td>
+      <td>Create new chats</td>
+    </tr>
+    <tr>
+      <td>🔔</td>
+      <td>Receive push notifications</td>
+    </tr>
+<tr>
+      <td>🌍</td>
+      <td>Start Telegram via WorldMenu</td>
+    </tr>
+    <tr>
+      <td>🚶</td>
+      <td>Logout</td>
+    </tr>
+  </tbody>
+</table>
 
 ## Resources for following groups
-We have a [Discord](https://discord.gg/craraGh) server setup with a Github Webhook, notifying us on important changes to the repository. Most exchanges happened in there, making it a valueable resource for successive groups.
+We have developed a [Project-Guide](https://github.com/hpi-swa-teaching/TelegramClient/wiki) which contains the most important information to continue developing the TelegramClient. Feel free to add new information to the wiki.
 
 ## Our Group
 Group 13 of the 2020 SWT I module incuded [Rohan Sawahn](https://github.com/rohansaw), [Jonas Schmidt](https://github.com/schmidtjonas), [Frederik Wollny](https://github.com/Freddy200), [Stefan Spangenberg](https://github.com/sspangenberg), [Lukas Laskowski](https://github.com/lasklu) and [Niklas Schilli](https://github.com/Mrnikbobjeff).