Skip to content

Commit 4d8cfb8

Browse files
Added package info to readme
1 parent 137e372 commit 4d8cfb8

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

README.md

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,13 @@ This repository documents the Supplier API specification and provides an SDK wit
2020
- [OAS Specifications](#oas-specifications)
2121
- [Table of Contents](#table-of-contents)
2222
- [API Consumers - Getting Started](#api-consumers---getting-started)
23-
- [API Developers](#api-developers)
23+
- [OAS Specification](#oas-specification)
24+
- [Packages](#packages)
2425
- [Documentation](#documentation)
26+
- [SDK Assets](#sdk-assets)
27+
- [Examples](#examples)
28+
- [API Developers](#api-developers)
29+
- [Documentation](#documentation-1)
2530
- [Setup](#setup)
2631
- [Prerequisites and Configuration](#prerequisites-and-configuration)
2732
- [Build](#build)
@@ -32,16 +37,32 @@ This repository documents the Supplier API specification and provides an SDK wit
3237

3338
## API Consumers - Getting Started
3439

35-
- View the [latest SDK documentation](https://nhsdigital.github.io/nhs-notify-supplier-api/)
36-
- Download SDKs from the [latest releases](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)
37-
- Python `sdk-python-[Version].zip`
38-
- TypeScript `sdk-ts-[Version].zip`
40+
### OAS Specification
41+
3942
- Download the OAS Specification File from the [latest releases](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)
4043
- OAS JSON files `api-oas-specification-[Version].zip`
44+
45+
### Packages
46+
47+
- [NPM package](https://github.com/NHSDigital/nhs-notify-supplier-api/pkgs/npm/nhsnotifysupplier)
48+
49+
### Documentation
50+
51+
- View the [latest SDK documentation](https://nhsdigital.github.io/nhs-notify-supplier-api/)
4152
- Download local versions of the API docs from the [latest releases](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)
4253
- HTML `sdk-html-[Version].zip`
4354
- Swagger `sdk-swagger-[Version].zip`
4455

56+
### SDK Assets
57+
58+
If packages are unavailable the latest SDKs can be downloaded directly from:
59+
60+
- Download SDKs from the [latest releases](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)
61+
- Python `sdk-python-[Version].zip`
62+
- TypeScript `sdk-ts-[Version].zip`
63+
64+
### Examples
65+
4566
TODO: Links to example clients.
4667

4768
## API Developers

0 commit comments

Comments
 (0)