diff --git a/ghost/limit-service/README.md b/ghost/limit-service/README.md index d2a2acae7c..bfc72cfb71 100644 --- a/ghost/limit-service/README.md +++ b/ghost/limit-service/README.md @@ -1,4 +1,8 @@ # Limit Service +This module is intended to hold **all of the logic** for testing if site: +- would be over a given limit if they took an action (i.e. added one more thing, switched to a different limit) +- if they are over a limit already +- consistent error messages explaining why the limit has been reached ## Install @@ -36,4 +40,4 @@ Follow the instructions for the top-level repo. # Copyright & License -Copyright (c) 2013-2021 Ghost Foundation - Released under the [MIT license](LICENSE). \ No newline at end of file +Copyright (c) 2013-2021 Ghost Foundation - Released under the [MIT license](LICENSE).