Updated and restructured library documentation to include Locale changes

Updated Getting Started Docs

Added documentation for Result Handling

removed api documentation
This commit is contained in:
anqixxx
2025-08-20 09:54:25 -04:00
parent 196de9e974
commit 4cdd2526b6
2 changed files with 14 additions and 6 deletions

View File

@@ -49,7 +49,11 @@ its address.
## Localization
Results are always returned with the full list of available names.
Results are always returned with the full list of available names. However, the
default `locale_name` must be explicitly set using the `localize` function within
`Locales`. This parses through the full list of available names to find the one
most preferred by the user. Once this is set, the user can simply use the
`display_name` field within a `Result` object to retrive the localized name.
### Locale