From 0d1bf671aa02b26c036db6d8ac9a087255cd124a Mon Sep 17 00:00:00 2001 From: Calvin Lau <77630796+calvin-lau-sig7@users.noreply.github.com> Date: Fri, 13 Sep 2024 13:15:55 +0100 Subject: [PATCH] Proposed restructure to show the new messages Remove that we'll 'keep data up to date' --- README.md | 49 +++++++++++++++++++++++++------------------------ 1 file changed, 25 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 9a2d28a..e0f1128 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,31 @@ -> [!IMPORTANT] -> **The GOV.UK country and territory autocomplete is no longer actively maintained.** -> -> It's recommended that you do not use this component, as: -> - it's only updated to address serious security issues – see the Support section for more information -> - it's highly likely that the country and territory data provided by this component is out of date – the [Openregister picker engine](https://github.com/alphagov/openregister-picker-engine), used to retrieve the country and territory data, is now archived -> -> The GOV.UK Design System Team plan to retire this component in the future. -> -> If you have a user need for a country and territory autocomplete or something resembling this component, we recommend using the [Accessible Autocomplete](https://github.com/alphagov/accessible-autocomplete) with [FCDO's geographical names index](https://www.gov.uk/government/publications/geographical-names-and-information) as a data source. Please note that this alternative hasn't been fully verified by the Design System team. We will be working on a more cohesive position on accommodating the needs met by this component in the future, during the retiring process. - -# GOV.UK country and territory autocomplete - what it is and how to use it +# GOV.UK country and territory autocomplete The country and territory autocomplete is a component that helps users choose countries and territories in answers. You should only use this component for services where users have to provide their country or territory. +## The GOV.UK country and territory autocomplete is no longer actively maintained + +It's recommended that you do not use this component, as: +* it's only updated to address serious security issues – see the Support section for more information +* it's highly likely that the country and territory data provided by this component is out of date – the [Openregister picker engine](https://github.com/alphagov/openregister-picker-engine), used to retrieve the country and territory data, is now archived + +The GOV.UK Design System Team plan to retire this component in the future. + +## Support + +The GOV.UK Design System team maintains the country and territory autocomplete. However, we’re only able to put in minimal work to support it. + +[Read about our plans to maintain this component](https://github.com/alphagov/govuk-country-and-territory-autocomplete/issues/106). + +[Read more about the types of support we can provide](https://github.com/alphagov/govuk-country-and-territory-autocomplete/issues/91). + +## Alternatives + +[The Foreign, Commonwealth & Development Office (FCDO) maintains a list of approved British English-language names for countries and territories](https://www.gov.uk/government/publications/geographical-names-and-information), which could be combined with the [Accessible autocomplete component](https://github.com/alphagov/accessible-autocomplete). + +The Design System has not fully verified the combination of these 2 resources. We plan to make a recommendation for service teams in the future as part of retiring the GOV.UK country and territory autocomplete component. + +## How to use this component + This component includes complete functionality to make it faster and easier for users to find a location. For example, to select their country of birth or their current location. For other types of question, you should use the accessible autocomplete. To find information about this component, go to the [accessible-autocomplete README](https://github.com/alphagov/accessible-autocomplete/blob/main/README.md). @@ -29,18 +42,6 @@ This guide will show you how to: [Try out the example.](https://alphagov.github.io/govuk-country-and-territory-autocomplete/examples/) ---- - -## Support - -The GOV.UK Design System team maintains the country and territory autocomplete. However, we’re only able to put in minimal work to support it. - -[Read about our plans to maintain this component](https://github.com/alphagov/govuk-country-and-territory-autocomplete/issues/106). - -[Read more about the types of support we can provide](https://github.com/alphagov/govuk-country-and-territory-autocomplete/issues/91). - ---- - ## Integration process To integrate an application with the autocomplete, you'll need to: