diff --git a/README.md b/README.md index 885245f..52d5b34 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,50 @@ # wpf-kanban-examples -This repository contains different samples demonstrating about WPF kanban control. + +Comprehensive WPF Kanban control examples showcasing sorting and data management techniques using Syncfusion UI framework. + +## Overview + +This repository demonstrates advanced kanban board implementations using WPF and Syncfusion components. It includes practical examples of custom field sorting and index-based sorting for task management workflows. + +## Prerequisites + +- Visual Studio 2019 or higher +- .NET Framework 4.5+ +- Syncfusion WPF NuGet packages +- Windows OS + +## Getting Started + +### Steps to Run + +1. Clone the repository to your local machine +2. Open the solution file in Visual Studio +3. Restore NuGet packages +4. Build the solution +5. Run the application + +## Project Details + +### CustomFieldSorting Example + +Demonstrates sorting kanban cards by custom fields like Priority. Features include: +- Dynamic sort direction control (Ascending/Descending) +- Mapping path selection for sorting criteria +- Priority-based task organization +- Three-column workflow: Open, In Progress, Done + +### IndexBasedSorting Example + +Demonstrates sorting kanban cards by index rank. Features include: +- Index-based card ordering and ranking +- Sort direction toggle +- Rank display on cards +- Workflow state management + +## Key Features + +- Interactive kanban boards with drag-and-drop +- Real-time sorting and filtering +- MVVM architecture with ViewModel pattern +- Custom card templates with rich content +- Multi-column task workflow management