Skip to content

Commit bce044d

Browse files
authored
Added usage instructions in README.md (#26)
1 parent 0ea01cc commit bce044d

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,21 @@ The library consists of two modules:
1212

1313
Both modules provide the `best_matching_locale` function.
1414

15+
### Usage
16+
17+
To use `locale-match` in your project, add it to your `Cargo.toml`:
18+
19+
```toml
20+
# Both modules are included by default.
21+
locale-match = "x.y.z"
22+
23+
# Include only the `bcp47` module.
24+
locale-match = { version = "x.y.z", default-features = false, features = ["bcp47"] }
25+
26+
# Include only the `posix` module.
27+
locale-match = { version = "x.y.z", default-features = false, features = ["posix"] }
28+
```
29+
1530
## Examples
1631

1732
### BCP 47

0 commit comments

Comments
 (0)