From d2c86960390a7fe849c1617fc417102ff2fa55dc Mon Sep 17 00:00:00 2001 From: Lee Read Date: Thu, 22 Sep 2022 11:40:15 -0400 Subject: [PATCH] Make a "babashka built-in" badge available (#1366) * Make a "babashka built-in" badge available Of note: added markdown and adoc syntaxes for badges to README. Closes #1365 * Moved flair section under new badges section Badges themselves act as headings under badges section. Reworded badges text for 2 audiences. 1. The general bb user who wants to know what they mean. 2. The library author who might want to display them. Renamed "Projects" heading to "Compatible Projects" --- README.md | 60 ++++++++++++++++++++++++++++++++++++----- logo/built-in-badge.svg | 1 + 2 files changed, 54 insertions(+), 7 deletions(-) create mode 100644 logo/built-in-badge.svg diff --git a/README.md b/README.md index 8b63a9c2..a1e17bef 100644 --- a/README.md +++ b/README.md @@ -286,22 +286,68 @@ Check out the [news](doc/news.md) page to keep track of babashka-related news it Go [here](https://book.babashka.org/#built-in-namespaces) to see the full list of built-in namespaces. -## [Projects](doc/projects.md) +## [Compatible Projects](doc/projects.md) A list of projects (scripts, libraries, pods and tools) known to work with babashka. -### Flair - -Do you have a library that runs with babashka? Add this badge to add some flair -to your repo: +## Badges + [![bb compatible](/logo/badge.svg)](https://babashka.org) -The raw HTML: +The babashka compatible badge indicates that a [library can be used as babashka dependency](doc/projects.md). -``` html +If this is the case for your library, we encourage you to proudly display this badge. + +
Markdown + +```markdown +[![bb compatible](https://raw.githubusercontent.com/babashka/babashka/master/logo/badge.svg)](https://babashka.org) +``` +
+ +
AsciiDoc + +```asciidoc +https://babashka.org[image:https://raw.githubusercontent.com/babashka/babashka/master/logo/badge.svg[bb compatible]] +``` +
+ +
HTML + +```html bb compatible ``` +
+
+ +[![bb built-in](/logo/built-in-badge.svg)](https://babashka.org) + +The babashka built-in badge means that a [library has been built directly into babashka](https://book.babashka.org/#built-in-namespaces) and requires no extra dependencies to use it. + +If this rare honor belongs to your library, you should display this badge. + +
Markdown + +```markdown +[![bb built-in](https://raw.githubusercontent.com/babashka/babashka/master/logo/built-in-badge.svg)](https://babashka.org) +``` +
+ +
AsciiDoc + +```asciidoc +https://babashka.org[image:https://raw.githubusercontent.com/babashka/babashka/master/logo/built-in-badge.svg[bb built-in]] +``` +
+ +
HTML + +```html +bb built-in +``` +
+
## [Pods](https://github.com/babashka/babashka.pods) diff --git a/logo/built-in-badge.svg b/logo/built-in-badge.svg new file mode 100644 index 00000000..afeae2eb --- /dev/null +++ b/logo/built-in-badge.svg @@ -0,0 +1 @@ +babashka: built-inbabashkabuilt-in \ No newline at end of file