From f23bd76255921c1a9027ab39120d910016279fa3 Mon Sep 17 00:00:00 2001 From: Chris Hill-Scott Date: Tue, 30 Oct 2018 13:30:46 +0000 Subject: [PATCH] Update description of what the API repo is for --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index dd0c7fab2..06a93dd34 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ [![Requirements Status](https://requires.io/github/alphagov/notifications-api/requirements.svg?branch=master)](https://requires.io/github/alphagov/notifications-api/requirements/?branch=master) [![Coverage Status](https://coveralls.io/repos/alphagov/notifications-api/badge.svg?branch=master&service=github)](https://coveralls.io/github/alphagov/notifications-api?branch=master) -# notifications-api -Notifications api -Application for the notification api. +# GOV.UK Notify API -Read and write notifications/status queue. -Get and update notification status. +Contains: +- the public-facing REST API for GOV.UK Notify, which teams can integrate with using [our clients](https://www.notifications.service.gov.uk/documentation) +- an internal-only REST API built using Flask to manage services, users, templates, etc (this is what the [admin app](http://github.com/alphagov/notifications-admin) talks to) +- asynchronous workers built using Celery to put things on queues and read them off to be processed, sent to providers, updated, etc ## Setting Up