Skip to content

Commit

Permalink
Added more extensive documentation to README.md (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
@pasabanov
pasabanov committed Sep 28, 2024
1 parent db51fad commit b82b9e0
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@

A small library for selecting the best match for user's preferred locales from available locales.

The library consists of two modules:
* `bcp47` - for matching locales in the [BCP 47](https://www.ietf.org/rfc/bcp/bcp47.html) format
* `posix` - for matching locales in the [POSIX](https://pubs.opengroup.org/onlinepubs/9799919799/basedefs/V1_chap08.html) format

Both modules provide the `best_matching_locale` function.

## Examples

### BCP 47
Expand Down

0 comments on commit b82b9e0

Please sign in to comment.