Skip to content

docs(readme): add the graph-compose-emoji install snippet for the v1.9.0 emoji feature #261

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.

Sign up for GitHub

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
DemchaAV merged 1 commit into from
Jun 29, 2026
Merged

docs(readme): add the graph-compose-emoji install snippet for the v1.9.0 emoji feature #261

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,23 @@ dependencies { implementation("io.github.demchaav:graph-compose:1.8.0") }
> above) to pull the engine + fonts together. Full details and upgrade steps:
> the [v1.8.0 fonts migration note](./docs/migration/v1.8.0-fonts.md).

> **Colour emoji (from v1.9.0).** `RichText.emoji(":star:", size)` resolves
> GitHub-style shortcodes to inline vector glyphs from an independently-versioned
> companion artifact (the same split model as the fonts above). Text without
> emoji needs nothing extra; to render colour emoji, add:
>
> ```xml
> <dependency>
> <groupId>io.github.demchaav</groupId>
> <artifactId>graph-compose-emoji</artifactId>
> <version>1.0.0</version>
> </dependency>
> ```
>
> An unknown shortcode falls back to its literal text, so a document that uses no
> emoji &mdash; or runs without the artifact &mdash; renders unchanged. The
> `graph-compose-bundle` stays fonts-only; emoji is opt-in.

> **Distribution** &mdash; Maven Central is the canonical channel from **v1.6.6** onwards
> (`io.github.demchaav:graph-compose:<version>`). Hosted Javadocs auto-publish to
> [javadoc.io/doc/io.github.demchaav/graph-compose](https://javadoc.io/doc/io.github.demchaav/graph-compose)
Expand Down
Loading