diff --git a/Clario.Desktop/Clario.Desktop.parcel b/Clario.Desktop/Clario.Desktop.parcel index ac44630..74d2da5 100644 --- a/Clario.Desktop/Clario.Desktop.parcel +++ b/Clario.Desktop/Clario.Desktop.parcel @@ -2,7 +2,7 @@ "GeneralSettings": { "NetProjectPath": "Clario.Desktop.csproj", "ApplicationName": "Clario", - "Version": "0.3.0", + "Version": "0.4.0", "PackageName": { "$type": "msbuild", "property": "AssemblyName" diff --git a/Clario/Assets/logo-textmark-no-bg.png b/Clario/Assets/logo-textmark-no-bg.png new file mode 100644 index 0000000..6ea0451 Binary files /dev/null and b/Clario/Assets/logo-textmark-no-bg.png differ diff --git a/README.md b/README.md index fce02bc..b6365e4 100644 --- a/README.md +++ b/README.md @@ -1 +1,104 @@ -# Clario \ No newline at end of file +
+ +Clario Logo + +# Clario + +**A clean, fast personal finance tracker for the desktop.** + +[![Beta](https://img.shields.io/badge/status-beta-f59e0b?style=flat-square)](https://github.com/yourusername/clario) +[![Built with Avalonia](https://img.shields.io/badge/built%20with-Avalonia%20UI-8b5cf6?style=flat-square)](https://avaloniaui.net/) +[![.NET](https://img.shields.io/badge/.NET-8.0-512bd4?style=flat-square)](https://dotnet.microsoft.com/) +[![License](https://img.shields.io/badge/license-MIT-22c55e?style=flat-square)](./LICENSE) + +
+ +--- + +> ⚠️ **Clario is currently in beta.** Expect rough edges. Feedback and bug reports are welcome. + +--- + +## Overview + +Clario is a native desktop app for tracking personal finances — expenses, income, and budgets — without the clutter of a browser tab. Built with [Avalonia UI](https://avaloniaui.net/), it runs natively on Windows, macOS, and Linux. + +--- + +## Screenshots + +> _Screenshots coming soon. The UI is still being polished._ + + + +--- + +## Features + +- 📋 **Expense & income tracking** — Log transactions with categories, amounts, dates, and notes +- 📅 **Date range filtering** — Quickly slice your data by day, week, month, or custom range +- 🏷️ **Categories** — Organize transactions with custom categories and icons +- 📊 **Spending overview** — At-a-glance summaries of where your money is going +- 🌙 **Dark-first UI** — Designed for dark mode from the ground up +- 🖥️ **Cross-platform** — Runs natively on Windows, macOS, and Linux + +--- + +## Tech Stack + +| Layer | Technology | +|---|---| +| UI Framework | [Avalonia UI 11](https://avaloniaui.net/) | +| Language | C# / .NET 8 | +| Architecture | MVVM | +| Icons | [Lucide](https://lucide.dev/) | + +--- + +## Getting Started + +Download the latest release for your platform from the [Releases](https://github.com/yourusername/clario/releases) tab and run the installer. + +If you'd prefer to run from source: + +```bash +git clone https://github.com/yourusername/clario.git +cd clario +dotnet run --project Clario +``` + +> Requires the [.NET 8 SDK](https://dotnet.microsoft.com/download) when running from source. + +--- + +## Project Status + +Clario is in active development. Core tracking features work, but some things are still being built out: + +- [x] Transaction entry & editing +- [x] Category management +- [x] Date range picker +- [x] Expense list with filtering +- [x] Budget goals +- [ ] Budget goal notifications +- [ ] Charts & reports +- [ ] CSV import / export +- [ ] Recurring transactions + +--- + +## Contributing + +The project isn't formally open to contributions yet while the core is still being shaped, but feel free to open an issue if you find a bug or have a suggestion. + +--- + +
+ +Made with ☕ and Avalonia UI. + +
\ No newline at end of file