From a6bbcc97c70d73adc93448faa5c521422746a9d5 Mon Sep 17 00:00:00 2001 From: Petr Sabanov Date: Fri, 31 Jan 2025 05:47:11 +0300 Subject: [PATCH] Added usage instructions in README.md --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 3dac08c..8f9e843 100644 --- a/README.md +++ b/README.md @@ -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