update readme

Author: tkotthakota-adobe

.github/workflows/ci.yaml

@@ -48,8 +48,12 @@ jobs:
 
       - name: Clean npm cache
         run: npm cache clean --force
+
+      - name: Create empty cache directory
+        run: mkdir -p /tmp/empty-cache
+
       - name: Install dependencies
-        run: npm ci
+        run: npm ci --cache /tmp/empty-cache
 
   semantic-release:
     runs-on: ubuntu-latest

README.md

@@ -1,6 +1,58 @@
 # SpaceCat Task Processor
 
-> SpaceCat Task Processor for processing spacecat tasks.
+## Overview
+
+SpaceCat Task Processor is a Node.js service that processes messages from the AWS SQS queue `SPACECAT-TASK-PROCESSOR-JOBS`. Based on the `type` field in each message, it dispatches the message to the appropriate handler for processing various site-related tasks.
+
+## Features
+- Receives and processes messages from SQS
+- Supports multiple task types via modular handlers
+- Handlers for audit status, demo URL preparation, and disabling imports/audits
+- Extensible and easy to add new handlers
+
+## Handlers
+- **audit-status-processor**: Checks and reports audit status for a site
+- **demo-url-processor**: Prepares and shares a demo URL for a site
+- **disable-import-audit-processor**: Disables specified imports and audits for a site
+
+## Project Structure
+- `src/` - Main source code
+  - `audit-status-processor/handler.js`
+  - `demo-url-processor/handler.js`
+  - `disable-import-audit-processor/handler.js`
+  - `index.js` - Main entry point and handler dispatcher
+- `test/` - Test files
+
+## Setup
+1. Clone the repository
+2. Install dependencies:
+   ```sh
+   npm ci
+   ```
+3. Configure AWS credentials and environment variables as needed
+
+## Usage
+- The service is designed to run as a serverless function or background worker.
+- It listens for messages on the SQS queue and processes them automatically.
+
+## Development
+- To run tests:
+  ```sh
+  npm test
+  ```
+- To lint code:
+  ```sh
+  npm run lint
+  ```
+
+## Extending
+To add a new handler:
+1. Create a new folder in `src/` for your handler.
+2. Export your handler function.
+3. Add it to the handler mapping in `src/index.js`.
+
+---
+For more details, see the documentation in `src/README.md`.
 
 ## Status
 [![codecov](https://img.shields.io/codecov/c/github/adobe-rnd/spacecat-task-processor.svg)](https://codecov.io/gh/adobe-rnd/spacecat-task-processor)

docs/README.md

@@ -0,0 +1,32 @@
+# SpaceCat Task Processor Documentation
+
+## Introduction
+SpaceCat Task Processor is a modular Node.js service that processes messages from the AWS SQS queue `SPACECAT-TASK-PROCESSOR-JOBS`. It dispatches each message to a handler based on the message's `type` field, supporting a variety of site-related automation tasks.
+
+## Architecture Overview
+- **SQS Integration:** Listens to the `SPACECAT-TASK-PROCESSOR-JOBS` queue and processes incoming messages.
+- **Handler System:** Uses a mapping in `src/index.js` to route messages to the correct handler module. Handlers are located in subdirectories of `src/` (e.g., `audit-status-processor`, `demo-url-processor`, `disable-import-audit-processor`).
+- **Extensibility:** New handlers can be added by creating a new directory and registering the handler in `src/index.js`.
+
+## Main Handlers
+- **audit-status-processor:** Checks and reports audit status for a site.
+- **demo-url-processor:** Prepares and shares a demo URL for a site.
+- **disable-import-audit-processor:** Disables specified imports and audits for a site.
+
+## Project Structure
+- `src/` - Source code and handlers
+- `test/` - Test files
+- `docs/` - Documentation (this file)
+
+## For Users
+- See the root `README.md` for setup, usage, and quick start instructions.
+
+## For Developers
+- See `src/README.md` for handler interface, message format, and extension guidelines.
+
+## Additional Resources
+- [npm documentation](https://docs.npmjs.com/)
+- [AWS SQS documentation](https://docs.aws.amazon.com/sqs/)
+
+---
+For any questions or contributions, please refer to the repository's issue tracker or contact the maintainers.