Refactor project structure, separate concerns, and enhance usage documentation

[x0rw]

Hey 👋 , love this project.

• Moved internal lock and helper functions out of lib.rs to improve clarity and separation of concerns.
• Isolated error types into a dedicated errors.rs module for better error handling and modularity.
• Restructured the project layout by moving integration tests to the/testsdirectory.

Updated README.md with comprehensive usage examples:

• Environment-based configuration
• Manual client configuration
• Service registration and deregistration

i'm working on adding acl feature on my branch after this is pushed, i will open a pr for it too.

Checks

Please check these off before promoting the pull request to non-draft status.

• All CI checks are green.
• I have reviewed the proposed changes myself.

[github-actions]

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

[x0rw]

I have read the CLA Document and I hereby sign the CLA

[kushudai]

Hi @x0rw, thank you for this PR!

My main concern here is primarily the breaking changes from types moving to be within modules.

Any thoughts on re-exporting them from lib.rs?

[x0rw]

Hey @kushudai, Thanks for the review,
About lock and errors exporting i will address them in the next commit--shortly.
I will use 'cargo public-api diff' to ensure there are no breaking changes in this repo.

[x0rw]

This is the report generated by cargo public-api diff. There are no changes or removals to the public API now.
Additionally, quick_error!() is unmaintained(i checked, the last update was 4 years ago) and no longer considered ergonomic, lacking proper visibility control. It would be beneficial to migrate to thiserror for long-term maintainability.

Removed items from the public API
=================================
(none)

Changed items in the public API
===============================
(none)

Added items to the public API
=============================
+impl rs_consul::Consul

[kushudai]

This is the report generated by cargo public-api diff. There are no changes or removals to the public API now. Additionally, quick_error!() is unmaintained(i checked, the last update was 4 years ago) and no longer considered ergonomic, lacking proper visibility control. It would be beneficial to migrate to thiserror for long-term maintainability.

Removed items from the public API
=================================
(none)

Changed items in the public API
===============================
(none)

Added items to the public API
=============================
+impl rs_consul::Consul

Thank you, you're right. This crate has not seen as much love as I would like it to.
You're welcome to fix that in this PR but I don't want ask more of you or throw scope creep on this change.

I'm happy to pick that up separately.

[x0rw]

It's not an issue at all, I'd be happy to look into that.

[kushudai]

Feel free to mark this as PR ready when you feel comfortable about merging this.
Again, thank you for the work!

[x0rw]

It's ready for merging now, i will work on a feature next week.