Skip to content

Commit 29404aa

Browse files
committed
Add some comments to README
1 parent 368c1ea commit 29404aa

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
11
# UnicodeNext
22

33
[![Build Status](https://github.com/c42f/UnicodeNext.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/c42f/UnicodeNext.jl/actions/workflows/CI.yml?query=branch%3Amain)
4+
5+
A unicode library which can be upgraded to the latest unicode rules, even on
6+
old Julia versions.
7+
8+
The interface here is an amalgamation of Julia's `Unicode` stdlib and the
9+
functions from Base's strings/unicode.jl. The implementation is a Julia port of
10+
the C library [utf8proc](https://github.com/JuliaStrings/utf8proc) which has
11+
traditionally powered Base's unicode functionality.
12+
13+
Ideally I (Claire) hope this library might become the implementation of the
14+
Unicode stdlib and the Base functions from strings/unicode.jl, such as
15+
`islowercase()`, etc. But we'd need to figure out the implications of trying to
16+
make this upgradable without breaking how it's integrated into the Julia
17+
sysimage.

0 commit comments

Comments
 (0)