From 43b77a41b6966f64f383026a0d465849f010b88c Mon Sep 17 00:00:00 2001
From: Kamil Kalarus <kalkalax@gmail.com>
Date: Sun, 29 Dec 2024 21:43:03 +0100
Subject: [PATCH] Create README.md

---
 README.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 88 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1719e21
--- /dev/null
+++ b/README.md
@@ -0,0 +1,88 @@
+<h1 align="center">TiCloud - Your personal productivity assistant</h1>
+
+<p align="center">
+  <a href="https://github.com/kamilkalarus">Kamil Kalarus</a>
+</p>
+
+TiCloud is a desktop application for monitoring and managing time spent working on software projects. The main purpose of the application is to help users track work sessions, organise projects and analyse the time spent on different tasks.
+
+
+<p align="center">
+  <img src="docs/ezgif-frame-001.jpg" width="45%" />
+  <img src="docs/demo.gif" width="45%" />
+</p>
+
+## News
+- 2024-12-??: First version of TiCloud
+
+## Features of TiCloud
+- Simple and intuitive to use 
+- Background work 
+- Access to applications from the system tray
+
+## Roadmap
+- Development of the visual side of the application
+- Adding tasks to a work session 
+- Possibility of generating reports (weekly/monthly/annually)
+- Integration with the GitHub platform 
+
+## Installation
+
+### Using the ready-made app installation wizard
+To install the application, download the contents of the _relese_ branch. 
+
+They can be downloaded using Git Bash:
+```bash
+git clone --branch release --single-branch https://github.com/Kalkalax/TiCloud
+```
+If you are not interested in cloning the repository, just [download the latest app release (1.0.0)]().
+
+Then follow the instructions below:
+
+- if you downloaded the `.ZIP` archive extract all the contents to one location,
+- run `setup.exe`,
+- follow the instructions of the installation wizard.
+
+### Advanced installation (developers)
+
+If you are interested in the source code or want to introduce your own implementation, use the instructions below.
+
+<details>
+  <summary>Read more</summary>
+  Each branch contains different content and, depending on your preferences, you can install applications in several ways:
+
+  - `release`<sup>1</sup> - contains an application installer that will guide you through the entire process
+  - `master` - contains a compiled version of the application ready to use (_without installer_)
+  - `develop` - includes the source code of the application along with the VS project and the necessary documentation
+
+  ### Acquiring a Git repository
+  The repository can be obtained in two ways
+  - Cloning a Git repository
+
+    - To download the entire repository, run Git Bash on the target location and call:
+
+    ```bash
+    git clone https://github.com/Kalkalax/TiCloud
+    ```
+
+  - Downloading the archive `.ZIP`<sup>2</sup>
+    - [release]() 
+    - [master]()
+    - [develop]()
+    
+ ><sup>1</sup> _recommended for users who only want to use the application's capabilities_<br>
+ ><sup>2</sup> _each branch must be downloaded separately_
+</details>
+
+
+
+## Documentation
+
+- [Development documentation]() (_currently unavailable_)
+
+
+## License
+
+[MIT License](LICENSE) © Kamil Kalarus
+
+