-
Notifications
You must be signed in to change notification settings - Fork 33
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
1 parent
fc13e8f
commit 2a8f56c
Showing
1 changed file
with
13 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,12 @@ | ||
# NHS.UK React Components | ||
# NHS.UK React components | ||
|
||
- [NHS.UK React Components](#nhsuk-react-components) | ||
- [Coming from 0.x?](#coming-from-0x) | ||
- [Upgrading to 2.0](#upgrading-to-20) | ||
- [Upgrading to 3.0](#upgrading-to-30) | ||
- [Upgrading to 4.0](#upgrading-to-40) | ||
- [Installation](#installation) | ||
- [Usage](#usage) | ||
- [Documentation and examples / storybook](#documentation-and-examples) | ||
- [Maintainers](#maintainers) | ||
- [Preparing Releases](#preparing-releases) | ||
|
||
NHS.UK Frontend ported to React | ||
This repository contains the code for NHS.UK React components - a port of the [NHS.UK Frontend components](https://github.com/nhsuk/nhsuk-frontend). | ||
|
||
[![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) | ||
|
||
## Coming from 0.x? | ||
|
||
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. | ||
|
||
## Upgrading to 2.0 | ||
|
||
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. | ||
|
||
## Upgrading to 3.0 | ||
|
||
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. | ||
|
||
## Upgrading to 4.0 | ||
## Documentation and examples | ||
|
||
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. | ||
[View documentation and examples](https://nhsdigital.github.io/nhsuk-react-components) | ||
|
||
## Installation | ||
|
||
|
@@ -59,21 +36,26 @@ class GetStartedButton extends PureComponent { | |
} | ||
``` | ||
|
||
### Documentation and examples | ||
## Upgrading | ||
|
||
A storybook containing all of the components and their usage can be found [here](https://nhsdigital.github.io/nhsuk-react-components). | ||
* [Upgrading to 1.0](/docs/upgrade-to-1.0.md) | ||
* [Upgrading to 2.0](/docs/upgrade-to-2.0.md) | ||
* [Upgrading to 3.0](/docs/upgrade-to-3.0.md) | ||
* [Upgrading to 4.0](/docs/upgrade-to-4.0.md) | ||
|
||
## Maintainers | ||
|
||
**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:[email protected]). | ||
**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:[email protected]). | ||
|
||
- Thomas Judd-Cooper ([GitHub](https://github.com/tomdango)) | ||
- Sam Brown ([GitHub](https://github.com/samueldavidbrown)) | ||
- Luke Pearson ([GitHub](https://github.com/lukepearson)) | ||
- Kevin Kuszyk ([GitHub](https://github.com/kevinkuszyk)) | ||
- Kai Spencer ([GitHub](https://github.com/KaiSpencer)) | ||
- Ed Horsford ([GitHub](https://github.com/edwardhorsford)) | ||
- Jake Barton ([GitHub](https://github.com/jakeb-nhs)) | ||
|
||
## Preparing Releases | ||
## Preparing releases | ||
|
||
Releases run in CI using github actions. | ||
|
||
|