Skip to content

Commit db8c4f6

Browse files
authored
docs(readme): add the graph-compose-emoji install snippet for the v1.9.0 emoji feature (#261)
The "What's new in v1.9" block names colour emoji via the independently-versioned graph-compose-emoji module, but the install section gave no coordinate for it — only the fonts companion artifact had a copy-paste dependency block. Add a parallel graph-compose-emoji (1.0.0) snippet, noting emoji is opt-in (the bundle stays fonts-only) and that an unknown shortcode falls back to literal text.
1 parent b60bde1 commit db8c4f6

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,23 @@ dependencies { implementation("io.github.demchaav:graph-compose:1.8.0") }
100100
> above) to pull the engine + fonts together. Full details and upgrade steps:
101101
> the [v1.8.0 fonts migration note](./docs/migration/v1.8.0-fonts.md).
102102
103+
> **Colour emoji (from v1.9.0).** `RichText.emoji(":star:", size)` resolves
104+
> GitHub-style shortcodes to inline vector glyphs from an independently-versioned
105+
> companion artifact (the same split model as the fonts above). Text without
106+
> emoji needs nothing extra; to render colour emoji, add:
107+
>
108+
> ```xml
109+
> <dependency>
110+
> <groupId>io.github.demchaav</groupId>
111+
> <artifactId>graph-compose-emoji</artifactId>
112+
> <version>1.0.0</version>
113+
> </dependency>
114+
> ```
115+
>
116+
> An unknown shortcode falls back to its literal text, so a document that uses no
117+
> emoji &mdash; or runs without the artifact &mdash; renders unchanged. The
118+
> `graph-compose-bundle` stays fonts-only; emoji is opt-in.
119+
103120
> **Distribution** &mdash; Maven Central is the canonical channel from **v1.6.6** onwards
104121
> (`io.github.demchaav:graph-compose:<version>`). Hosted Javadocs auto-publish to
105122
> [javadoc.io/doc/io.github.demchaav/graph-compose](https://javadoc.io/doc/io.github.demchaav/graph-compose)

0 commit comments

Comments
 (0)