diff --git a/README.md b/README.md index 9ab18c1..6488a47 100644 --- a/README.md +++ b/README.md @@ -184,16 +184,19 @@ files. ##### Cached configuration files. The cached project configuration files follow this naming convention: -`configuration..json`. StrawBoss uses the file modification time to -determine which configuration file is the most recent. These cached versions of -the project configration are only intended to be used in cases where StrawBoss -is not building anything and doesn't check out a copy of the repo. For example, -when a client queries the REST API for the list of steps in a project, -StrawBoss will consult the most recently modified cached copy of the project -configuration rather than cloning the entire repo just to answer this question. -Whenever StrawBoss has a copy of the repo, it should look for the actual -configuration file in that version of the repo instead of consulting the cached -configuration files. +`configuration..json`. These cached versions of the project +configration are only intended to be used in cases where StrawBoss is not +building anything and doesn't check out a copy of the repo. For example, when a +client queries the REST API for the list of steps in a project, StrawBoss will +consult the most recently modified cached copy of the project configuration +rather than cloning the entire repo just to answer this question. Whenever +StrawBoss has a copy of the repo, it should look for the actual configuration +file in that version of the repo instead of consulting the cached configuration +files. When determining the "most recent" cached copy, StrawBoss uses the +modification time of the files, again to avoid cloning the repo. API access to +project configurations in this manner is intended as a convenience. The actual +project configuration in the project repository should be considered the source +of truth. ##### Step and Version Directories