Skip to content

Commit 0be209b

Browse files
committed
Better hint at the package capabilities in readme
1 parent 37b9e4b commit 0be209b

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,14 @@
88
The `StyledStrings` package builds on top of the `AnnotatedString` type to
99
provide a full-fledged textual styling system, suitable for terminal and
1010
graphical displays.
11+
12+
This is primarily intended for package authors, who may think of this as
13+
`printstyled` on a (rather potent) steroids 😉. To get a better sense of what
14+
this means in practice, start with the [examples
15+
page](https://julialang.github.io/StyledStrings.jl/dev/examples/) of the
16+
documentation and look for how other packages use `StyledStrings` in the Julia
17+
ecosystem.
18+
19+
This is a standard library as of Julia 1.11. A version compatible with Julia 1.0
20+
through to 1.10 has also been registered in General — allowing `StyledStrings`
21+
to be used anywhere without compromising compatibility.

0 commit comments

Comments
 (0)