Skip to content
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

readme: add babashka built-in badge #193

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

lread
Copy link
Collaborator

@lread lread commented Oct 19, 2022

Cheshire is built directly into babashka, we can let folks know that at-a-glance with the bb built-in badge!

Cheshire is built directly into babashka, we can let folks know that at-a-glance with the bb built-in badge!
@lread
Copy link
Collaborator Author

lread commented Mar 13, 2025

@dakrone I just noticed this oldie but goodie PR of mine! Shall I update so it is mergeable?

@dakrone
Copy link
Owner

dakrone commented Mar 13, 2025

I think I'd prefer it as a snippet of text rather than a badge, is there a benefit to the badge over text that explains what "built in" means?

@lread
Copy link
Collaborator Author

lread commented Mar 13, 2025

Hmmm... good feedback! A reader might not know what it means.

The badge is a convention.
Maybe it should, rather than link to babashka, link to some place on bababashka that explains what it is.

Right now it goes to https://babashka.org:
bb built-in

But maybe we could instead point to https://github.com/babashka/babashka/blob/master/README.md#badges:
bb built-in

Whaddya think?

@dakrone
Copy link
Owner

dakrone commented Mar 14, 2025

Part of the confusion here is that I think it indicates something different. If I were to see a badge that said "babashka | built-in" on a project, I would assume that project had babashka built-in, not the other way around. Adding the badge here implies that Cheshire has Babashka built-in. That's part of why I think a snippet of text is clearer because it can say something like "The Babashka project has Cheshire built-in, to allow for JSON encoding/decoding without additional libraries or dependencies."

@lread
Copy link
Collaborator Author

lread commented Mar 14, 2025

Oh. Interesting! That interpretation had not occurred to me, but I totally get it.
There are not a ton of built-in libs for babashka, but the badge is used as an indicator for libraries that are built-in https://grep.app/search?q=built-in-badge.svg

I wonder if we should come up with a clearer babashka badge for these built-in libs.
The intent was to have the badge quickly convey to readers that the lib is built into babashka.

If I can exercise your patience, and get more feedback, would the following be less ambiguous?

image

Whatcha think?

I think adding your text to the README makes sense, but am also hoping for an at-a-glance badge that would be clearer.

@dakrone
Copy link
Owner

dakrone commented Mar 14, 2025

I think that badge suffers from the same confusion, it appears that Babashka is a library built in to Cheshire, rather than the other way around.

@lread
Copy link
Collaborator Author

lread commented Mar 14, 2025

Your feedback here will likely ultimately inspire some badge that is clearer, but I'm coming up dry on alternatives right now.

I'll ask in the babashka Slack channel for ideas.

@lread
Copy link
Collaborator Author

lread commented Mar 14, 2025

If you are interested link to Slack chat on subject: https://clojurians.slack.com/archives/CLX41ASCS/p1741977532653299 (as of this writing the only real comment is "A badge is a badge, you can't tell the whole story")

I think the badge gives folks a conventional at-a-glance signal of how cheshire fits into the the babashka ecosystem. Unfamiliar users would click through to learn the details, if curious.

That said, if you still really don't like the babashka badge, that's OK. I think I've done all I can to sell you on the idea. 😅 I fully respect that cheshire is your lib, and that you should stand by what you are comfortable with.

@lread
Copy link
Collaborator Author

lread commented Mar 18, 2025

Well, I did not sell you on the badge, but the discussion helped us to improve click through. We now click through to content that describes the badge, so that's good!

bb built-in

@dakrone
Copy link
Owner

dakrone commented Mar 18, 2025

I'll add some text to the readme that describes it as well, linking to the project.

@dakrone
Copy link
Owner

dakrone commented Mar 18, 2025

I pushed 89ae2d1 to clarify this a bit. I haven't played with Babashka yet, but I intend to, thanks!

@borkdude
Copy link
Contributor

@dakrone Looking forward to hear your thoughts on bb!

@lread
Copy link
Collaborator Author

lread commented Mar 18, 2025

@dakrone, I like your text, and since you have the explanatory text, you could now add the badge too? Or, if you are still badge-resistant, feel free to close this issue.

If you do add the badge, note the markdown has changed since I created this PR, it is now:

[![bb built-in](https://raw.githubusercontent.com/babashka/babashka/master/logo/built-in-badge.svg)](https://book.babashka.org#badges)

As you might have guessed, I'm a huge fan of @borkdude's babashka. I find it awesome for cross-os scripting. And... it even has a great json lib built-in! 😃

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.

3 participants