diff --git a/README.md b/README.md index 47c5521b6..a8207a1e2 100644 --- a/README.md +++ b/README.md @@ -3,18 +3,19 @@ https://travis-ci.org/alphagov/notifications-admin.svg # notifications-admin Application to handle the admin functions of the notifications application. -Features of this application: - Register users. - Register services. - Download CSV for an email or sms batch. - Show history of notifications. - Reports. +### Features of this application: + - -Create a virtual environment for this project +### Create a virtual environment for this project mkvirtualenv -p /usr/local/bin/python3 notifications-admin -GOV.UK frontend toolkit +### GOV.UK frontend toolkit The GOV.UK frontend toolkit is a submodule of this project. To get the content of the toolkit run the following two commands @@ -22,6 +23,6 @@ GOV.UK frontend toolkit git submodule update -To run the sample application run: +### To run the sample application run: pip install -r requirements.txt - python app.py \ No newline at end of file + python app.py