From fa100794ad393934a6687f6afa6f84d76b6c592c Mon Sep 17 00:00:00 2001 From: stvnrlly Date: Fri, 18 Nov 2016 23:14:21 -0500 Subject: [PATCH] update readme with buy information --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2f37c10..4319d26 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ Optionally, populate the database with some fake data: ``` ./manage.py create_team ./manage.py create_projects +./manage.py create_buys --add ``` Because of the authentication flow, a superuser should be created without a @@ -65,9 +66,17 @@ than building it into the templates. ### Projects API This app includes information about the projects that the team is working on and -provides an API for retrieving that information. In the interest of API-first -development, information about the projects on the site is built by consuming -that API rather than building it into the templates. +provides an API for retrieving that information. + +This includes a few elements: + +- IAAs: A bundle of money authorized to be spent by a client on projects +- Projects: A grouping of work around a common goal +- Buys: The individual procurements in the service of completing the project +goal. + +In the interest of API-first development, information about the projects on the +site is built by consuming that API rather than building it into the templates. ### UAA Authentication