summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
author zaaarf <me@zaaarf.foo>2024-02-12 21:07:22 +0100
committer zaaarf <me@zaaarf.foo>2024-02-12 21:21:54 +0100
commita1433a32eefc77b5b6722be8cf86ad2ac8406941 (patch)
treeac684b145a53b28f939cec60b61368de6a53bab7 /README.md
parentecfe19f7e8046eab3608115b3ad3d77731b99f98 (diff)
docs: written docs
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
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.