-
Notifications
You must be signed in to change notification settings - Fork 155
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
base: master
Are you sure you want to change the base?
Conversation
Cheshire is built directly into babashka, we can let folks know that at-a-glance with the bb built-in badge!
@dakrone I just noticed this oldie but goodie PR of mine! Shall I update so it is mergeable? |
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? |
Hmmm... good feedback! A reader might not know what it means. The badge is a convention. Right now it goes to https://babashka.org: But maybe we could instead point to https://github.com/babashka/babashka/blob/master/README.md#badges: Whaddya think? |
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." |
Oh. Interesting! That interpretation had not occurred to me, but I totally get it. I wonder if we should come up with a clearer babashka badge for these built-in libs. If I can exercise your patience, and get more feedback, would the following be less ambiguous? 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. |
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. |
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. |
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. |
I'll add some text to the readme that describes it as well, linking to the project. |
I pushed 89ae2d1 to clarify this a bit. I haven't played with Babashka yet, but I intend to, thanks! |
@dakrone Looking forward to hear your thoughts on bb! |
@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: [](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! 😃 |
Cheshire is built directly into babashka, we can let folks know that at-a-glance with the bb built-in badge!