Update README.md and Documentation Based on Recent Changes

[loftwah]

Our documentation, particularly the README.md file, has not been updated in a while. We need to review recent pull requests and issues to ensure our documentation accurately reflects the current state of the project.

Tasks:

1. Review Changes:

   • Go through the PR and issue history since the last README.md modification
   • Compile a list of significant changes, new features, and important fixes

2. Update README.md:

   • Update the project description if necessary
   • Revise the feature list to include new functionality
   • Update installation instructions if the process has changed
   • Modify usage examples to reflect current best practices
   • Update any outdated screenshots or diagrams

3. Review and Update Other Documentation:

   • Check and update API documentation if applicable
   • Review and revise any developer guides
   • Update user guides to include new features or changed workflows

4. Verify Documentation Accuracy:

   • Cross-reference documentation updates with actual code and functionality
   • Ensure all examples in the documentation work as described

5. Improve Documentation Structure:

   • Reorganize sections if necessary for better readability
   • Add a table of contents if not already present
   • Ensure consistent formatting throughout

6. Add/Update Contribution Guidelines:

   • Review and update the process for contributing to the project
   • Ensure the code of conduct is up to date

7. Version Information:

   • Update any version numbers or compatibility information

8. External Links:

   • Check and update any external links in the documentation

9. Localization:

   • If applicable, ensure changes are reflected in all language versions of the documentation

10. Review and Proofread:

    • Perform a final review for accuracy, clarity, and completeness
    • Proofread for grammar and spelling errors

11. Seek Feedback:

    • Have other team members review the updated documentation
    • Address any feedback or suggestions

12. Prepare for Merge:

    • Create a pull request with all documentation changes
    • Ensure the PR includes a summary of major updates

This update will ensure that our documentation accurately reflects the current state of the project, making it easier for new users and contributors to understand and use our application.