From c92e18ec5aadd88f4f69afad90f550745fd8890a Mon Sep 17 00:00:00 2001 From: Kip Cole Date: Wed, 24 Apr 2024 07:11:46 +1000 Subject: [PATCH] Update readme --- README.md | 6 +++--- mix.exs | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 34eb010..74a93ff 100644 --- a/README.md +++ b/README.md @@ -99,15 +99,15 @@ The `t:Cldr.PersonName.t/0` struct is composed of one or more name parts: * `given_name` - usually a name given to someone that is not passed to a person by way of parentage. * `informal_given_name` - usually either a nickname or a shortened form of the given name that is used to address a person informally. * `other_given_names` - name or names that may appear between the first given name string and the surname. In the West, this may be a middle name, in Slavic regions it may be a patronymic name, and in parts of the Middle East, it may be the nasab (نسب) or series of patronymics. -* `surname_prefix` - In some languages the surname may have a prefix that needs to be treated differently, for example “van den Berg”. +* `surname_prefix` - in some languages the surname may have a prefix that needs to be treated differently, for example “van den Berg”. * `surname` - usually the family name passed to a person that indicates their family, tribe, or community. In most Western languages, this is known as the last name. * `other_surnames` - in some cultures, both the parent’s surnames are used and need to be handled separately for formatting in different contexts. * `generation` - a string that represents a generation marker, such as “Jr.” or “III”. * `credentials` - a string that represents one or more credentials or accreditations, such as “M.D.”, or “MBA”. * `locale` - defines the `t.Cldr.LanguageTag.t/0` of a name. This allows different formatting of a name depending on whether it is being formatted for its native locale, or for a different locale. -* `name_order` - an atom indicating the preferred name order for this name. The valid values are `:given_first`, `:surname_first`, `:sorting`. By default, `ex_cldr_person_names` will derive the name order based upon the name's locale and the formatting locale. +* `preferred_order` - an atom indicating the preferred name order for this name. The valid values are `:given_first`, `:surname_first`, `:sorting`. By default, `ex_cldr_person_names` will derive the name order based upon the name's locale and the formatting locale. -**At mininum, a `given_name` is required. All other data elements are optional**. +**At mininum, a `given_name` is required. All other name attributes are optional**. ## Integration with Existing Data diff --git a/mix.exs b/mix.exs index 559d555..b2eb4ef 100644 --- a/mix.exs +++ b/mix.exs @@ -1,7 +1,7 @@ defmodule Cldr.PersonName.Mixfile do use Mix.Project - @version "0.1.0" + @version "0.2.0" def project do [