Skip to content

Add API reference badge to README.md #4236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 26, 2024
Merged

Add API reference badge to README.md #4236

merged 2 commits into from
Sep 26, 2024

Conversation

qwwdfsad
Copy link
Collaborator

A bit easier and more convenient to find quickly

A bit easier and more convenient to find quickly
Copy link
Collaborator

@dkhalanskyjb dkhalanskyjb left a comment

Choose a reason for hiding this comment

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

When we added the badge to kotlinx-datetime, there were questions about consistent badge order across libraries: Kotlin/kotlinx-datetime#256 (comment).

https://github.com/Kotlin/kotlinx-datetime and https://github.com/Kotlin/kotlinx.serialization are now inconsistent with one another for some reason, but both suggest that the API reference goes above Slack but after both Kotlin and Maven Central.

I myself don't have a preference for any particular order of badges (and am not bothered by the variance across different libraries: our README.md is already fully free-form, it seems), so if you think the last line is the best place to put the badge, I don't mind.

@qwwdfsad
Copy link
Collaborator Author

Thanks for pointing it out. I'm completely OK with any reasonable order -- if anyone feels we benefit from consistent order across the board, then why not.

Put it before Slack based on a subjective feeling it's slightly better :)

@qwwdfsad qwwdfsad merged commit 58f880e into develop Sep 26, 2024
@qwwdfsad qwwdfsad deleted the api-ref-badge branch September 26, 2024 16:35
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