diff --git a/backend/README.md b/backend/README.md index 62e2fa7..6d5791e 100644 --- a/backend/README.md +++ b/backend/README.md @@ -8,3 +8,5 @@ This is just an orginizational way of keeping the backend services together (so - [`public`](./public/README.md) - a RESTful API service - [`task`](./task/README.md) - a task scheduler service +- [`storage`](./storage/README.md) - an internal storage library +- [`cache`](./cache/README.md) - an internal caching library diff --git a/backend/cache/README.md b/backend/cache/README.md new file mode 100644 index 0000000..ee78d89 --- /dev/null +++ b/backend/cache/README.md @@ -0,0 +1,7 @@ +# Caching library + +also known as `cache` + +## What is this? + +An internal caching library that houses functionality needed for a key-value database like Redis or Valkey. This was turned into a library because both `public` and `task` needed functionality within. diff --git a/backend/storage/README.md b/backend/storage/README.md new file mode 100644 index 0000000..7cb4034 --- /dev/null +++ b/backend/storage/README.md @@ -0,0 +1,7 @@ +# Storage library + +also known as `storage` + +## What is this? + +An internal storage library. This was needed because both `public` and `task` needed storage functionality. Additionally, this helps maintainability and avoids duplicate code.