|
1 |
| -# NHS.UK React Components |
| 1 | +# NHS.UK React components |
2 | 2 |
|
3 |
| -- [NHS.UK React Components](#nhsuk-react-components) |
4 |
| - - [Coming from 0.x?](#coming-from-0x) |
5 |
| - - [Upgrading to 2.0](#upgrading-to-20) |
6 |
| - - [Upgrading to 3.0](#upgrading-to-30) |
7 |
| - - [Upgrading to 4.0](#upgrading-to-40) |
8 |
| - - [Installation](#installation) |
9 |
| - - [Usage](#usage) |
10 |
| - - [Documentation and examples / storybook](#documentation-and-examples) |
11 |
| - - [Maintainers](#maintainers) |
12 |
| - - [Preparing Releases](#preparing-releases) |
13 |
| - |
14 |
| -NHS.UK Frontend ported to React |
| 3 | +This repository contains the code for NHS.UK React components - a port of the [NHS.UK Frontend components](https://github.com/nhsuk/nhsuk-frontend). |
15 | 4 |
|
16 | 5 | [](https://github.com/NHSDigital/nhsuk-react-components/actions?query=workflow%3A%22CI+Build%22+branch%3Amain) [](https://bundlephobia.com/result?p=nhsuk-react-components)
|
17 | 6 |
|
18 |
| -## Coming from 0.x? |
19 |
| - |
20 |
| -If you're coming from versions of the library prior to 1.0.0, please give [this doc](/docs/upgrade-to-1.0.md) a brief read, as there a number of changes between 0.x release and the 1.0 release. |
21 |
| - |
22 |
| -## Upgrading to 2.0 |
23 |
| - |
24 |
| -If you're upgrading to 2.0, please be aware we have made some breaking changes. [This doc](/docs/upgrade-to-2.0.md) has the details. |
25 |
| - |
26 |
| -## Upgrading to 3.0 |
27 |
| - |
28 |
| -If you're upgrading to 3.0, please be aware we have made some breaking changes. [This doc](/docs/upgrade-to-3.0.md) has the details. |
29 |
| - |
30 |
| -## Upgrading to 4.0 |
| 7 | +## Documentation and examples |
31 | 8 |
|
32 |
| -If you're upgrading to 4.0, please be aware we have made some breaking changes. [This doc](/docs/upgrade-to-4.0.md) has the details. |
| 9 | +[View documentation and examples](https://nhsdigital.github.io/nhsuk-react-components) |
33 | 10 |
|
34 | 11 | ## Installation
|
35 | 12 |
|
@@ -59,21 +36,26 @@ class GetStartedButton extends PureComponent {
|
59 | 36 | }
|
60 | 37 | ```
|
61 | 38 |
|
62 |
| -### Documentation and examples |
| 39 | +## Upgrading |
63 | 40 |
|
64 |
| -A storybook containing all of the components and their usage can be found [here](https://nhsdigital.github.io/nhsuk-react-components). |
| 41 | +* [Upgrading to 1.0](/docs/upgrade-to-1.0.md) |
| 42 | +* [Upgrading to 2.0](/docs/upgrade-to-2.0.md) |
| 43 | +* [Upgrading to 3.0](/docs/upgrade-to-3.0.md) |
| 44 | +* [Upgrading to 4.0](/docs/upgrade-to-4.0.md) |
65 | 45 |
|
66 | 46 | ## Maintainers
|
67 | 47 |
|
68 |
| -**We're currently looking for new maintainers!** If you have knowledge of React and would be willing to help maintain this library, you can email me (Thomas Judd-Cooper) [here](mailto:thomas.judd-cooper1@nhs.net). |
| 48 | +**We’re currently looking for new maintainers** If you have knowledge of React and would be willing to help maintain this library, you can [email me (Thomas Judd-Cooper)](mailto:thomas.judd-cooper1@nhs.net). |
69 | 49 |
|
70 | 50 | - Thomas Judd-Cooper ([GitHub](https://github.com/tomdango))
|
71 | 51 | - Sam Brown ([GitHub](https://github.com/samueldavidbrown))
|
72 | 52 | - Luke Pearson ([GitHub](https://github.com/lukepearson))
|
73 | 53 | - Kevin Kuszyk ([GitHub](https://github.com/kevinkuszyk))
|
74 | 54 | - Kai Spencer ([GitHub](https://github.com/KaiSpencer))
|
| 55 | +- Ed Horsford ([GitHub](https://github.com/edwardhorsford)) |
| 56 | +- Jake Barton ([GitHub](https://github.com/jakeb-nhs)) |
75 | 57 |
|
76 |
| -## Preparing Releases |
| 58 | +## Preparing releases |
77 | 59 |
|
78 | 60 | Releases run in CI using github actions.
|
79 | 61 |
|
|
0 commit comments