One paragraph description and purpose.
- Word: definition of word, and how it's used in the code
Write a single paragraph including a general technical overview of the app. Example:
This is a Ruby on Rails application that maps RESTful URLs onto a persistence layer. It's only presented as an internal API and doesn't face public users.
- alphagov/other-repo - provides some downstream service
- redis - provides a backing service for work queues
./startup.sh
Documentation for where the app will appear (default port, vhost, URL etc).
bundle exec rake
Include any other edge cases, e.g parallel test runner in Whitehall
one-line-curl-command with JSON response after
Keep this section limited to core endpoints - if the app is complex link out to /docs.