Updated Readme

README.md

@@ -1,38 +1,46 @@
-# Slint Rust Template
+# Aliveline
-
-A template for a Rust application that's using [Slint](https://slint.rs/) for the user interface.
 
 ## About
 
-This template helps you get started developing a Rust application with Slint as toolkit
+Aliveline is a small app made with Rust + Slint to track daily activity on a timeline.
-for the user interface. It demonstrates the integration between the `.slint` UI markup and
+All activity is saved into TOML logs, which are human readable/editable.
-Rust code, how to react to callbacks, get and set properties, and use basic widgets.
+
+Aliveline currently supports Linux.
+
+## Features
+
+### Events
+Events are main timeline building blocks. They have name, start and end.
+Example of event in TOML format shown below:
+```toml
+[[events]]
+name = "test"
+start = 12:05:45
+end = 13:00:11
+finished = true
+```
+_Note: if event is not finished yet, it may have `end = 00:00:00`._
+
+## Building
+Requirements:
+- Rust toolchain
+Instructions:
+Run `cargo build --release`
 
 ## Usage
 
-1. Install Rust by following its [getting-started guide](https://www.rust-lang.org/learn/get-started).
+Just run `aliveline` by any preferred way.
-   Once this is done, you should have the `rustc` compiler and the `cargo` build system installed in your `PATH`.
-2. Download and extract the [ZIP archive of this repository](https://github.com/slint-ui/slint-rust-template/archive/refs/heads/main.zip).
-3. Rename the extracted directory and change into it:
-    ```
-    mv slint-rust-template-main my-project
-    cd my-project    
-    ```
-4. Build with `cargo`:
-    ```
-    cargo build
-    ```
-5. Run the application binary:
-    ```
-    cargo run
-    ```
 
-We recommend using an IDE for development, along with our [LSP-based IDE integration for `.slint` files](https://github.com/slint-ui/slint/blob/master/tools/lsp/README.md). You can also load this project directly in [Visual Studio Code](https://code.visualstudio.com) and install our [Slint extension](https://marketplace.visualstudio.com/items?itemName=Slint.slint).
+## Configuration
+Aliveline tries to find config at `$XDG_CONFIG_DIR/aliveline/config.toml`.
+If config isn't found, or `$XDG_CONFIG_DIR` is not set, Aliveline uses default values.
 
-## Next Steps
+You can configure these values:
+- `log_path`
+    Type: `String`
+    Default: `logs`
+    Path to directory where logs are located.
+    Path may be absolute or relative to config directory.
 
-We hope that this template helps you get started, and that you enjoy exploring making user interfaces with Slint. To learn more
+## Contribution
-about the Slint APIs and the `.slint` markup language, check out our [online documentation](https://slint.dev/docs).
+You can contribute to Aliveline by creating issue on this repository, then we'll discuss it.
-
-Don't forget to edit this readme to replace it by yours, and edit the `name =` field in `Cargo.toml` to match the name of your
-project.