From a1433a32eefc77b5b6722be8cf86ad2ac8406941 Mon Sep 17 00:00:00 2001 From: zaaarf Date: Mon, 12 Feb 2024 21:07:22 +0100 Subject: docs: written docs --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 6efa688..90ad838 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,4 @@ # Fluent, fluently -I found myself needing to do localisation, one time. I decided I'd want it to happen at runtime, so that any spelling fixes may be applied without needing to recompile the whole program. [Fluent](https://github.com/projectfluent/fluent-rs) provides an API, but no real way to use it. I couldn't find any existing implementation fitting my use case, so I wrote this. +A small Rust library handling loading runtime loading of [Fluent](https://github.com/projectfluent/fluent-rs) localisation. By design, Fluent does not touch the IO part, only providing String parsing. This library takes care of that. + +I intentionally kept this as simple as possible to reflect my very basic use case. Check out [fluent-localization](https://github.com/AEnterprise/fluent-localization) for something with more features, namely compile-time validation and localisation struct generation for easier access. -- cgit v1.2.3-56-ga3b1