Feat/readme

[nafsonig]

Done — I added module documentation and linked it from the root README.

What I changed

• Added: README.md — describes endpoints, domain behavior, developer notes.
• Added: README.md — describes endpoints, lifecycle, audit expectations, developer notes.
• Updated root README: added a Module Docs section linking both files (README.md).

Next steps (optional)

• I can add more details or examples in either module README (request/response samples).
• I can create docs pages under docs or enable automated doc generation if you prefer.

Want me to open the new README files or add example request/response snippets?

Made changes.

Closes #609

Done — added comprehensive auth & user API docs and linked them from the root README.

What I added

• Auth_and_User_APIs.md — documents:
  • Registration (POST /auth/register) with payload example and success/error responses.
  • Login (POST /auth/login) with payload example and responses.
  • Refresh (POST /auth/refresh), Logout, Password reset request and reset endpoints with examples and error codes.
  • User management endpoints (/api/users) overview, expected errors.
  • Error format and developer notes (rate limits, testing guidance, tokens).
• Updated README.md to link the new doc under Module Docs.

Next actions (optional)

• Add OpenAPI/Swagger examples for these endpoints (I can generate snippets).
• Add sample curl commands or Postman collection for quick manual testing.
• Promote the doc into docs site pages if you have a static docs site.

Want me to add curl examples and a Postman/HTTPie collection next?

Made changes.

Closes #608

[drips-wave]

@nafsonig Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

[nanaf6203-bit]

LGTM