Merge pull request #5726 from Countly/SER-2092-improve-readmes-for-cognito-hooks-okta-push-approver-times-of-day-plugins

[SER-2092] Update readme files for hooks and times of day

Author: ArtursKadikis

plugins/hooks/README.md

@@ -62,3 +62,73 @@ hooks/                                      # Main hooks plugin directory
     ```bash
     npm install
     ```
+
+## Using Hooks
+
+First, ensure that Hooks is enabled. In the Sidebar, navigate to Management > Feature Management and switch on the Hooks toggle.
+
+## Creating a New Hook
+
+To create a new Hook in the Countly Hooks Plugin, follow these steps:
+
+### Step 1: Start a New Hook
+
+- Click on the **+ New Hook** button located in the top right corner of the default view. A new drawer will open where you’ll need to fill out the following fields.
+
+### Step 2: Fill in Hook Details
+
+1. **Hook Name**: Enter a concise and descriptive name for your Hook. This field is required and should adhere to SDK naming limitations.
+2. **Description** (optional): Provide a brief explanation of the Hook’s purpose. This can help your colleagues understand why it was created. Avoid long descriptions and special characters.
+3. **Source App**: Select the application where the Hook will apply. You can use the search bar to find your app, but only one app can be chosen per Hook. Click on **Next Step** to proceed to trigger selection.
+
+### Step 3: Select the Trigger Type
+
+From the dropdown, choose a trigger type for your Hook. Options include:
+
+- **Tracked Data**
+- **Internal Actions**
+- **API Endpoint**
+
+#### For Tracked Data
+
+- Choose a specific data point from the list or dropdown.
+- Set a filtering rule if needed; you may add multiple conditions.
+
+#### For Internal Actions
+
+- Select a trigger from the dropdown.
+- Depending on the chosen trigger, specify the details using the subsequent dropdown (e.g., select a specific cohort from the list).
+
+#### For API Endpoint
+
+- Choose a trigger from the dropdown.
+- Specify further using the new dropdown that appears (e.g., select a cohort).
+
+### Step 4: Set up a Recurring Trigger (Optional)
+
+Select one of the following frequencies for the trigger:
+
+- **Every hour** (includes time zone selection)
+- **Every day** (includes time zone selection)
+- **Every week** (select day of the week, hour, and time zone)
+- **Every month** (select day of the month from 1 to 28, hour, and time zone)
+
+Then, specify when the trigger should run.
+
+### Step 5: Choose an Action Type
+
+Choose an action from the dropdown options:
+
+- **Send Email**
+- **Make HTTP Request**
+- **Custom Code**
+
+You can add multiple actions by clicking **Add Action**.
+
+### Step 6: Test the Hook (Optional)
+
+- To verify if the Hook functions as expected, click the **Test the Hook** button. For further guidance, refer to the “Testing a Hook” section below.
+
+### Step 7: Save the Hook
+
+After completing all fields, click **Save**. A success message will confirm that your Hook has been saved successfully.

plugins/times-of-day/README.md

@@ -54,3 +54,34 @@ times-of-day/
     ```bash
     npm install
     ```
+
+## Using Times of Day
+
+The Times of Day feature allows you to analyze user activity based on specific time criteria. Follow these steps to effectively use this tool.
+
+### Step 1: Selecting Criteria
+
+- **Criteria Options**: Start by selecting a criteria from the **Dropdown Menu** at the top left. Available options include:
+  - **Sessions**
+  - **Events**
+  - **Consent**
+  - **Push Action**
+
+- **Time Period**: Use the **Dropdown Menu** at the top right to specify a time range. This will automatically refresh the data chart and data table with the relevant activity details.
+
+### Step 2: Understanding the Data Chart
+
+- The **Data Chart** shows activity by **hour of the day** (in 24-hour format on the x-axis) and **day of the week** (on the y-axis).
+- **Colored circles** represent activity levels at each time and day intersection. The larger the circle, the higher the number of users.
+- You can download this chart as a **PNG image** by clicking the **Downward Arrow** button at the top right of the chart.
+
+### Step 3: Understanding the Data Table
+
+- Below the Data Chart is the **Data Table**, which provides the information in a detailed, tabular format with specific user counts.
+- The table includes:
+  - **Hours**: Each hour of the day, in hourly segments.
+  - **Days**: Columns for each day of the week showing the active user count per hour.
+
+- You can export the table in **CSV, JSON, or XLSX** format by clicking the **Downward Arrow** button at the top right of the table.
+
+This feature is ideal for visualizing and exporting user activity based on selected criteria and time frames for further analysis.