darkhelm/notifications-api
1
0
Fork 0
mirror of https://github.com/GSA/notifications-api.git synced 2026-05-28 09:59:40 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2197 from alphagov/quis-patch-1

Browse Source 
Update description of what the API repo is for
This commit is contained in:
Chris Hill-Scott
2018-10-31 11:12:55 +00:00
committed by GitHub
parent f97fa6a31e f23bd76255
commit 87017fc3d1
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -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