Skip to content

Commit 2a8f56c

Browse files
Update readme to make docs more obvious (#249)
* Update readme to make docs more obvious * Add @jakeb-nhs * Simplify upgrade section at suggestion of @frankieroberto * Typography cleanup
1 parent fc13e8f commit 2a8f56c

File tree

1 file changed

+13
-31
lines changed

1 file changed

+13
-31
lines changed

README.md

Lines changed: 13 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,12 @@
1-
# NHS.UK React Components
1+
# NHS.UK React components
22

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).
154

165
[![GitHub Actions CI Status](https://github.com/NHSDigital/nhsuk-react-components/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/NHSDigital/nhsuk-react-components/actions?query=workflow%3A%22CI+Build%22+branch%3Amain) [![Bundle Size](https://img.shields.io/bundlephobia/minzip/nhsuk-react-components.svg)](https://bundlephobia.com/result?p=nhsuk-react-components)
176

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
318

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)
3310

3411
## Installation
3512

@@ -59,21 +36,26 @@ class GetStartedButton extends PureComponent {
5936
}
6037
```
6138

62-
### Documentation and examples
39+
## Upgrading
6340

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)
6545

6646
## Maintainers
6747

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+
**Were 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).
6949

7050
- Thomas Judd-Cooper ([GitHub](https://github.com/tomdango))
7151
- Sam Brown ([GitHub](https://github.com/samueldavidbrown))
7252
- Luke Pearson ([GitHub](https://github.com/lukepearson))
7353
- Kevin Kuszyk ([GitHub](https://github.com/kevinkuszyk))
7454
- Kai Spencer ([GitHub](https://github.com/KaiSpencer))
55+
- Ed Horsford ([GitHub](https://github.com/edwardhorsford))
56+
- Jake Barton ([GitHub](https://github.com/jakeb-nhs))
7557

76-
## Preparing Releases
58+
## Preparing releases
7759

7860
Releases run in CI using github actions.
7961

0 commit comments

Comments
 (0)