Skip to content

Added usage instructions in README.md #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pasabanov merged 1 commit into from
Jan 31, 2025
Merged

Added usage instructions in README.md #26

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
View file
Open in desktop
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