Skip to content

Commit

Permalink
Added usage instructions in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pasabanov committed Jan 31, 2025
1 parent 0ea01cc commit a6bbcc9
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,21 @@ The library consists of two modules:

Both modules provide the `best_matching_locale` function.

### Usage

To use `locale-match` in your project, add it to your `Cargo.toml`:

```toml
# Both modules are included by default.
locale-match = "x.y.z"

# Include only the `bcp47` module.
locale-match = { version = "x.y.z", default-features = false, features = ["bcp47"] }

# Include only the `posix` module.
locale-match = { version = "x.y.z", default-features = false, features = ["posix"] }
```

## Examples

### BCP 47
Expand Down

0 comments on commit a6bbcc9

Please sign in to comment.