Skip to content

Commit

Permalink
Merge pull request #3 from jenkinsci/feature/prepare_initial_release
Browse files Browse the repository at this point in the history
Prepare initial release
  • Loading branch information
strangelookingnerd authored Oct 10, 2024
2 parents 1fe2ded + f97c8a1 commit 70a000e
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[[emoji-symbols-api-plugin]]
= Emoji Symbols API Plugin
:toc: macro
:toclevels: 3
:toc-title:

image:https://ci.jenkins.io/job/Plugins/job/emoji-symbols-api-plugin/job/main/badge/icon[link="https://ci.jenkins.io/job/Plugins/job/emoji-symbols-api-plugin/job/main/"]
image:https://codecov.io/gh/jenkinsci/emoji-symbols-api-plugin/branch/main/graph/badge.svg[link="https://codecov.io/gh/jenkinsci/emoji-symbols-api-plugin"]
Expand All @@ -16,9 +19,11 @@ This plugin provides https://unicode.org/emoji/charts/full-emoji-list.html[Unico
The SVG files bundled by the plugin render the Emojis as `text` rather than `path`.
This allows emojis to be interpreted by the browser being used.

toc::[]

== Usage

The symbol names follow the pattern of `symbol-emoji_NAME plugin-emoji-symbols-api`.
The symbol names follow the pattern of `symbol-emoji___NAME__ plugin-emoji-symbols-api`.

Helper methods such as `io.jenkins.plugins.emoji.symbols.Emojis.getIconClassName` are provided by the plugin for easier generation of symbol identifiers.

Expand Down

0 comments on commit 70a000e

Please sign in to comment.