One paragraph description and purpose.
Screenshots (if there's a client-facing aspect of it)
Live examples (if available)
- 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
Running the application
Documentation for where the app will appear (default port, vhost, URL etc).
Running the test suite
bundle exec rake
Include any other edge cases, e.g parallel test runner in Whitehall
Any deviations from idiomatic Rails/Go etc. (optional)
Example API output (optional)
one-line-curl-command with JSON response after
Keep this section limited to core endpoints - if the app is complex link out to