README update

Author: cherryymerryy

README.md

@@ -1,20 +1,14 @@
 # sakuragram
 
-Custom Telegram Desktop client based on TDLib ([tdsharp](https://github.com/egramtel/tdsharp)) and WinUI 3
+Custom Telegram Desktop client based on TDLib ([tdsharp](https://github.com/egramtel/tdsharp), [tdlib](https://github.com/tdlib/td)) and WinUI 3 ([WinUI](https://github.com/microsoft/microsoft-ui-xaml), [CommunityToolKit](https://github.com/CommunityToolkit/Windows))
 
 [Telegram channel](https://t.me/sakuragram), [Telegram forum](https://t.me/sakuragramchat)
 
 ## Compilation Guide
-1. Clone sakuragram source code (`git clone https://github.com/cherryymerryy/sakuragram.git`)
-2. Download TDLib NuGet package (`dotnet add package TDLib --version 1.8.29`)
-3. Create Config directory and file Config.cs (`Config/Config.cs`)
-4. Fill out config file like this
-```c#
-namespace sakuragram.Config;
+1. Clone **sakuragram** source code (`git clone https://github.com/cherryymerryy/sakuragram.git`)
+2. Open **sakuraglam.sln**
+3. Open **Config_Example** and fill it in according to the comments
+4. After all the steps in the console, write `dotnet build` 
 
-public class Config
-{
-    public const int ApiId = your_api_id;
-    public const string ApiHash = "your_api_hash";
-}
-```
+## Contributing
+You can simply open a Pull Request with your idea or a ready-made function!

sakuragram/Config_Example.cs

@@ -0,0 +1,25 @@
+namespace sakuragram;
+
+/** Rename file and class to Config */
+public class Config_Example
+{
+    public const string AppName = "your_app_name";
+    public static readonly string AppVersion = GetAppVersion();
+    
+    /** You can get your Telegram API keys on the website my.telegram.org. I recommend updating the variable with its version every time TDLib is updated */
+    public const int ApiId = 0;
+    public const string ApiHash = "your_api_hash";
+    public const string TdLibVersion = "1.8.37";
+    
+    /** You need to create a GitHub Api Token for GitHub-related functions (in particular UpdateManager) to work correctly */
+    public const string GitHubAuthToken = "your_github_auth_token";
+    public const string GitHubRepoOwner = "your_github_repo_owner";
+    public const string GitHubRepoName = "your_github_repo_name";
+    public const string LinkForUpdate = $"https://api.github.com/repos/{GitHubRepoOwner}/{GitHubRepoName}/releases/latest";
+    
+    private static string GetAppVersion() {
+        System.Reflection.Assembly assembly = System.Reflection.Assembly.GetExecutingAssembly();
+        System.Diagnostics.FileVersionInfo fvi = System.Diagnostics.FileVersionInfo.GetVersionInfo(assembly.Location);
+        return fvi.FileVersion;
+    }
+}