README.md

# RFC 9839

A library to check whether a string, charlist or codepoint fits within the
Unicode subsets specified by [RFC 9839][rfc]. These subsets are designed to
exclude "problematic" codepoints, for varying definitions of "problematic".

[rfc]: https://www.rfc-editor.org/rfc/rfc9839


## Installation

Add `rfc9839` to your dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:rfc9839, "~> 0.1.0"}
  ]
end
```

## Usage

The library consists of a single module, `RFC9839`, that exposes a check
function for each of the three subsets specified in RFC 9839:

- `RFC9839.is_unicode_scalar?/1`
- `RFC9839.is_xml_character?/1`
- `RFC9839.is_unicode_assignable?/1`

Each function accepts either an integer codepoint, a charlist, or a string.