update markdown files

[eddyjaga]

Short Description / Link to Ticket

This pull request introduces version 2.0.1, focusing on documentation consistency and improvements, user management validation enhancements, and minor fixes. The main highlights are the standardization of the readme.md filename across the project, expanded and clarified documentation for user management, and updates to metadata and versioning for the gem.

Documentation and Naming Consistency:

• Standardized all references from README.md to readme.md across documentation, configuration files, templates, and metadata to ensure consistency and prevent case-related issues. This includes updates in .yardopts, .github/ISSUE_TEMPLATE/documentation.yml, contributing.md, zai_payment.gemspec, and multiple documentation files. [1] [2] [3] [4] [5] [6] [7] [8] [9]

User Management Enhancements:

• Improved user creation and company validation logic to enforce required fields based on user_type, adding clarity to which fields are mandatory for payin and payout users and companies. Also clarified that device_id and ip_address are not required for payin users but are required when creating an item and charging a card.
• Refactored company validation logic for maintainability and reduced cyclomatic complexity.

Documentation Updates:

• Updated user management documentation, user examples, and company field requirements to reflect the new validation logic and clarify when certain fields are required.
• Fixed and clarified date of birth formatting in user examples and documentation to use DD/MM/YYYY (e.g., 01/01/1990). [1] [2]

Versioning and Metadata:

• Bumped gem version to 2.0.1 in lib/zai_payment/version.rb.
• Updated gemspec metadata to reference the correct filenames for changelog and code of conduct.
• Added release notes for version 2.0.1 in changelog.md. [1] [2]

Other Minor Fixes:

• Updated placeholders, file references, and documentation links throughout the project for accuracy and consistency. [1] [2] [3]

These changes improve the reliability of the documentation, enhance user management features, and ensure consistency across the codebase.

Testing

Additional Notes