Skip to content

Commit e5623db

Browse files
committed
update readme
1 parent 4e156b7 commit e5623db

File tree

1 file changed

+20
-18
lines changed

1 file changed

+20
-18
lines changed

README.md

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -29,24 +29,26 @@ This will provide the expanded and normalized addresses ready for geocoding quer
2929
Support additional parameters:
3030

3131
- `languages`: An array of language codes (e.g., ["en", "fr"]) to help with expansion
32-
- `address_components`: A bitmask of address components to expand
33-
- `latin_ascii`: Transliterate to Latin ASCII (true/false)
34-
- `transliterate`: Transliterate to the script of the first language (true/false)
35-
- `strip_accents`: Strip accents from the address (true/false)
36-
- `decompose`: Decompose diacritics and other characters (true/false)
37-
- `lowercase`: Convert the address to lowercase (true/false)
38-
- `trim_string`: Trim leading and trailing whitespace (true/false)
39-
- `replace_word_hyphens`: Replace hyphens in words with spaces (true/false)
40-
- `delete_word_hyphens`: Delete hyphens in words (true/false)
41-
- `replace_numeric_hyphens`: Replace hyphens in numbers with spaces (true/false)
42-
- `delete_numeric_hyphens`: Delete hyphens in numbers (true/false)
43-
- `split_alpha_from_numeric`: Split alphabetic and numeric parts of the address (true/false)
44-
- `delete_final_periods`: Deletes final periods (true/false)
45-
- `delete_acronym_periods`: Deletes periods in acronyms (e.g., "U.S.A." -> "USA") (true/false)
46-
- `drop_english_possessives`: Drops "'s" from the end of tokens (e.g., "St. James's" -> "St. James") (true/false)
47-
- `delete_apostrophes`: Deletes apostrophes (true/false)
48-
- `expand_numex`: Expands numeric expressions (e.g., "Twenty-third" -> "23rd") (true/false)
49-
- `roman_numerals`: Converts Roman numerals to integers (e.g., "II" -> "2") (true/false)
32+
- `address_components`: An array of strings specifying which parts of the address to expand. If not provided, a default set of components is used. See the **Address Components** section below for all available values.
33+
- `latin_ascii`: Transliterate to Latin ASCII (`true` default value)
34+
- `transliterate`: Transliterate to the script of the first language (`true` default value)
35+
- `strip_accents`: Strip accents from the address (`true` default value)
36+
- `decompose`: Decompose diacritics and other characters (`true` default value)
37+
- `lowercase`: Convert the address to lowercase (`true` default value)
38+
- `trim_string`: Trim leading and trailing whitespace (`true` default value)
39+
- `replace_word_hyphens`: Replace hyphens in words with spaces (`true` default value)
40+
- `delete_word_hyphens`: Delete hyphens in words (`true` default value)
41+
- `replace_numeric_hyphens`: Replace hyphens in numbers with spaces (`false` default value)
42+
- `delete_numeric_hyphens`: Delete hyphens in numbers (`false` default value)
43+
- `split_alpha_from_numeric`: Split alphabetic and numeric parts of the address (`true` default value)
44+
- `delete_final_periods`: Deletes final periods (`true` default value)
45+
- `delete_acronym_periods`: Deletes periods in acronyms (e.g., "U.S.A." -> "USA") (`true` default value)
46+
- `drop_english_possessives`: Drops "'s" from the end of tokens (e.g., "St. James's" -> "St. James") (`true` default value)
47+
- `delete_apostrophes`: Deletes apostrophes (`true` default value)
48+
- `expand_numex`: Expands numeric expressions (e.g., "Twenty-third" -> "23rd") (`true` default value)
49+
- `roman_numerals`: Converts Roman numerals to integers (e.g., "II" -> "2") (`true` default value)
50+
51+
#### Address Components
5052

5153
You also can select which parts of the address to expand. If not provided, a default set of components is used
5254

0 commit comments

Comments
 (0)