Skip to content

Commit d38af83

Browse files
committed
docs: Update and enhance README documentation
Improved project description, updated technology stack sections, clarified features, and added a Contact section. Updated license reference to GPL-3.0 and made minor corrections for clarity and accuracy throughout the README.
1 parent b79fe17 commit d38af83

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed

README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# FinTrack - WPF Personal Finance Tracker
1+
# **FinTrack - WPF Personal Finance Tracker**
22

3-
FinTrack is a modern, user-friendly desktop application for personal finance management, built with WPF and .NET 8. It helps you track income, expenses, and investments to achieve your financial goals.
3+
FinTrack is a modern, user-friendly desktop application for personal finance management, built with WPF and .NET 8. It helps you track your income, expenses, and budgets to achieve your financial goals.
44

55
![License](https://img.shields.io/badge/license-GPL-blue.svg)
66
![.NET](https://img.shields.io/badge/.NET-8.0-purple.svg)
@@ -16,14 +16,15 @@ FinTrack is a modern, user-friendly desktop application for personal finance man
1616
- [Getting-Started](#getting-started)
1717
- [Contributing](#contributing)
1818
- [License](#license)
19+
- [Contact](#contact)
1920

2021
## Overview
2122

22-
FinTrack provides a comprehensive solution for tracking daily financial transactions, creating budgets, and generating insightful reports. It is developed using C# with a modern .NET 8 stack, utilizing a local SQLite database for secure data storage. The application follows the MVVM design pattern for a clean and maintainable codebase.
23+
FinTrack provides a comprehensive solution for tracking daily financial transactions, creating budgets, and generating insightful reports. It is developed using C# with a modern .NET 8 stack. The application uses a local **SQLite** database for secure data storage and follows the **MVVM (Model-View-ViewModel)** design pattern for a clean and maintainable codebase.
2324

24-
Please click on the image to watch the video on YouTube.
25+
Click on the image to watch the promotional video on YouTube.
2526

26-
[<img src="https://t.ctcdn.com.br/gbO3hsV5DRUS3MYFIL0-vgDJtYk=/640x360/smart/i533291.png" width="50%">](https://youtu.be/0r24kuKRQ6A)
27+
[<img src="https://i.ytimg.com/vi/0r24kuKRQ6A/hq720.jpg" width="60%">](https://youtu.be/EMGObq-SWrA)
2728

2829
### Design Philosophy
2930

@@ -38,9 +39,9 @@ Please click on the image to watch the video on YouTube.
3839

3940
- **Transaction Tracking**: Categorize and monitor all your financial activities.
4041
- **Smart Reporting**: Generate reports to analyze financial trends.
41-
- **Budget Management**: Set budget limits for categories with alerts.
42+
- **Budget Management**: Set budget limits for categories and receive alerts.
4243
- **Visual Analysis**: Interactive charts and a dashboard to visualize spending.
43-
- **Secure Local Storage**: Data is stored locally in an SQLite database.
44+
- **Secure Local Storage**: Data is stored securely in a local SQLite database.
4445
- **Modern UI**: A clean and responsive user interface built with WPF.
4546

4647
### Technical Features
@@ -55,7 +56,7 @@ Please click on the image to watch the video on YouTube.
5556

5657
## Technology Stack
5758

58-
### Backend & Core
59+
### Core & Data
5960
- **Framework**: .NET 8.0
6061
- **ORM**: Entity Framework Core
6162
- **Database**: SQLite
@@ -64,16 +65,15 @@ Please click on the image to watch the video on YouTube.
6465
- **JSON Serialization**: Newtonsoft.Json
6566
- **Authentication**: System.IdentityModel.Tokens.Jwt
6667

67-
### Frontend
68+
### UI & Visualization
6869
- **UI Framework**: WPF (Windows Presentation Foundation)
69-
- **Charting**: LiveChartsCore.SkiaSharpView.WPF
70+
- **Charting Library**: LiveChartsCore.SkiaSharpView.WPF
7071
- **Styling**: Custom modern styles (see `Styles/ModernStyles.xaml`)
7172

7273
### Development Tools
7374
- **IDE**: Visual Studio 2022
7475
- **Package Manager**: NuGet
7576
- **Version Control**: Git & GitHub
76-
- **CI/CD**: GitHub Actions
7777

7878
## Project Structure
7979

@@ -100,7 +100,7 @@ FinTrack/
100100
### Prerequisites
101101

102102
- .NET 8.0 SDK
103-
- Visual Studio 2022 (with WPF workload)
103+
- Visual Studio 2022 (with the WPF workload installed)
104104
- Git
105105

106106
### Installation & Running
@@ -129,12 +129,18 @@ Contributions are welcome! If you'd like to contribute, please follow these step
129129
130130
1. **Fork** the repository.
131131
2. Create a new **feature branch** (`git checkout -b feature/YourAmazingFeature`).
132-
3. **Commit** your changes (`git commit -m 'Add some AmazingFeature'`).
132+
3. **Commit** your changes (`git commit -m 'feat: Add some AmazingFeature'`).
133133
4. **Push** to the branch (`git push origin feature/YourAmazingFeature`).
134134
5. Open a **Pull Request**.
135135
136136
Please ensure your code adheres to the existing style and that you provide clear descriptions for your changes.
137137
138138
## 📄 License
139139
140-
This project is licensed under the **MIT License**. See the [LICENSE](LICENSE) file for details.
140+
This project is licensed under the **GPL-3.0 License**. See the [LICENSE](LICENSE) file for details.
141+
142+
## 📞 Contact
143+
144+
- **Project Owner:** Enes Efe Tokta
145+
- **Email:** [enesefetokta@gmail.com](mailto:enesefetokta@gmail.com)
146+
- **LinkedIn:** [https://www.linkedin.com/in/enes-efe-tokta/](https://www.linkedin.com/in/enes-efe-tokta/)

0 commit comments

Comments
 (0)