Merge pull request #5751 from Countly/SER-2093-improve-readmes-for-alerts-compliance-hub-plugins

[SER-2093] improve readmes for alerts and compliance hub plugins

Author: ArtursKadikis

plugins/alerts/README.md

@@ -1,6 +1,6 @@
 # Alerts plugin
 
-The Alerts plugin is designed to monitor various metrics and events within the Countly analytics platform. It provides a structured way to set up alerts for different types of data, ensuring that users are notified when specific conditions are met. Below is a detailed breakdown of the plugin's file structure and its components:
+The Alerts plugin in Countly is a reactive tool designed to keep you informed about critical changes in your application’s metrics, even when you’re not monitoring dashboards. It sends email notifications when specific conditions on important metrics are met, enabling you to respond quickly to potential issues. This feature helps ensure your app maintains high performance and provides a positive user experience by alerting you to areas that may need immediate attention.
 
 ## File structure
 File structure follows usual Countly plugin structure
@@ -41,6 +41,17 @@ alerts/
 └── tests.js                                    # plugin tests
 ```
 
+## Key Features
+
+- **Customizable Alerts:** Define specific conditions for metrics such as crashes, cohorts, data points, events, Net Promoter Score (NPS), online users, rating, revenue, sessions, surveys, users, and views. Get notified whenever these conditions are met.
+- **Real-Time Notifications:** Receive email alerts for immediate awareness of changes in your metrics.
+- **Detailed Monitoring:** Track a broad range of metrics, including user engagement, performance, user feedback, and error rates.
+- **Easy Setup:** Simple configuration allows you to set and customize alerts quickly to fit your needs.
+
+## Example Use Case
+
+Imagine you’ve released a new version of your app. Although it passed all tests, some critical bugs may still slip through. These bugs might prevent users from fully using the app. By setting up alerts for sudden spikes in crashes or decreased user activity, you can catch these issues early and work to resolve them, ensuring minimal disruption.
+
 ## Generate alerts job
 
 Job name: alerts:monitor

plugins/compliance-hub/README.md

@@ -27,4 +27,18 @@ compliance-hub/
 ├── package.json
 ├── README.md
 └── tests.js                                  # plugin tests
-```
+```
+
+## Key Features
+
+- **Collect User Consents:** Prompt first-time users to consent to data collection, detailing which types of data (e.g., sessions, crashes, views) will be collected. No data is sent unless the user opts in.
+- **Manage User Requests:** The "Consents" tab (available in Enterprise Edition) lets admins view and fulfill user requests for data export or deletion.
+- **SDK Integration:** Countly SDKs (iOS, Android, Node.js, Web) support flexible consent management, allowing opt-in/opt-out on a per-feature basis. SDKs default to opt-in for backward compatibility but can be configured to require opt-in consent at initialization.
+
+## Using the Compliance Hub
+
+Access the Compliance Hub via Main Menu > Utilities > Compliance Hub. The Compliance Hub offers the following views:
+1. **Metrics View:** Track opt-ins and opt-outs across various features (e.g., sessions, crashes) over time in a time-series graph.
+2. **Users View:** List users with consent histories. Each entry shows user ID, device info, app version, and consent types. Options include viewing consent history, exporting user data, and purging data if required.
+3. **Consent History:** A complete list of all opt-in and opt-out actions across metrics, allowing for easy tracking.
+4. **Export/Purge History:** See a record of all data export and deletion actions for compliance tracking.