Skip to content

Comments

docs: update README with API documentation and usage examples#15

Merged
robertodauria merged 6 commits intomainfrom
sandbox-roberto-readme
Feb 2, 2026
Merged

docs: update README with API documentation and usage examples#15
robertodauria merged 6 commits intomainfrom
sandbox-roberto-readme

Conversation

@robertodauria
Copy link
Contributor

@robertodauria robertodauria commented Feb 2, 2026

Summary

  • Add API endpoints table documenting all service endpoints
  • Add development section with build, test, and Docker commands
  • Add configuration table with all flags and defaults
  • Add CLI tools documentation for create-integration
  • Add usage section with integration endpoint request/response examples
  • Add architecture overview with Mermaid sequence diagram

This change is Reviewable

Copy link
Collaborator

@bassosimone bassosimone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow, I like this a lot. Here's tiny request for minor improvements.

Copy link
Collaborator

@bassosimone bassosimone left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🐳

@robertodauria robertodauria merged commit 719c299 into main Feb 2, 2026
2 of 4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants