docs: add HTTP API details to README#15
Merged
MuhammadSaim merged 1 commit intoMuhammadSaim:masterfrom Jan 16, 2026
Merged
Conversation
Owner
|
Thank you so much for this PR and for the thoughtful addition to the README 🙌 I really appreciate the time and care you put into documenting the public HTTP API and sharing the Cloud Run deployment. Thanks again for your precious work and for helping improve the project 🚀 |
Contributor
Author
|
Thanks for merging. More contributions coming up. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a new section to the README documenting a public HTTP API for goavatar.
Context
I initially planned to build a public identicon service in Go and discovered that goavatar was the perfect fit. To make the library accessible to non-Go developers and for quick
integration, I deployed it to Google Cloud Run. This update shares the public endpoint so others can easily use the tool via a REST interface.