Updated readme with module description

refs https://github.com/TryGhost/Team/issues/510

- Explained the intention and responsibility ares of the module
This commit is contained in:
naz 2021-03-31 13:05:46 +13:00 committed by GitHub
parent b72c428c2e
commit df222e6d64

View File

@ -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).
Copyright (c) 2013-2021 Ghost Foundation - Released under the [MIT license](LICENSE).