add Readme.md

README.md

@@ -0,0 +1,56 @@
+# Account Reconciliation Reference
+
+## Overview
+This Odoo module enhances the bank reconciliation interface by displaying and managing reference information more effectively. It adds visibility and functionality for the 'ref' field across various reconciliation views and operations.
+
+## Features
+
+### Bank Reconciliation Views
+- **Kanban Cards**: Shows the 'ref' field on bank reconciliation kanban cards for `account.bank.statement.line` records
+- **List View**: Adds 'ref' column to bank reconciliation list view, making it visible by default
+- **Search Functionality**: Includes 'ref' field in the bank reconciliation search, allowing users to filter by reference
+
+### Journal Items Reconciliation
+- Displays 'ref' field in Journal Items Reconcile list view for better visibility of reference information
+
+### Manual Operations Panel
+- Shows reference field in the Manual Operations panel for non-liquidity lines
+- Makes the reference field editable for liquidity lines in the reconciliation form
+- Persists the reference value to both the journal entry (`move.ref`) and statement line (`st_line.ref`) when entered
+
+### Data Persistence
+- When a reference is entered in Manual Operations, it's saved to both the journal entry reference and the statement line reference
+- Reference values are maintained after validation and reconciliation operations
+- Reference data is preserved when clicking Validate in reconciliation interface
+
+## Technical Implementation
+
+### Models
+- Extends `bank.rec.widget` model to handle reference field persistence
+- Implements `_line_value_changed_ref()` method to persist reference values to both journal entry and statement line
+- Overrides `_action_validate()` method to ensure reference values are saved before reconciliation
+
+### Views
+- Extends kanban view for `account.bank.statement.line` to display reference
+- Modifies tree view for `account.bank.statement.line` to show reference column by default
+- Updates search view for `account.bank.statement.line` to include reference in search
+- Extends reconciliation tree view for `account.move.line` to show reference field
+- Custom XML template extends the manual operations panel in reconciliation form
+
+## Usage
+
+1. Navigate to the bank reconciliation interface
+2. References will now be visible in kanban cards and list views
+3. Use the search functionality to filter by reference
+4. In Manual Operations panel, you can view and edit references for liquidity lines
+5. When entering a reference and validating, it will be persisted to both the journal entry and statement line
+
+## Dependencies
+- `account_accountant` - Core accounting module with reconciliation features
+
+## Compatibility
+- Odoo Version: 17.0
+- Module Version: 17.0.1.0.2
+
+## License
+LGPL-3