docs: minor improvements

README.md

@@ -47,17 +47,19 @@ checks:
       weekdays:
         timezone: "America/New_York"
         times:
-          - at: "14:00"
-            tolerance: "5m"
+          - "14:00"
+        # Only allow check-ins between 13:55 and 14:05
+        tolerance: "5m"
 
   - id: "5pm-close"
     name: "Close out for the day"
     schedule:
       bankingDays:
         timezone: "America/New_York"
         times:
-          - at: "17:00"
-            tolerance: "5m"
+          - "17:00"
+        # Only allow check-ins between 16:55 and 17:05
+        tolerance: "5m"
 
 # Global alert configuration
 alert:

docs/examples/config.yaml

@@ -20,7 +20,8 @@ checks:
     schedule:
       weekdays:
         timezone: "America/New_York"
-        times: ["17:00"]
+        times: ["14:00"]
+        # Only allow check-ins between 13:55 and 14:05
         tolerance: "5m"
 
   # - id: "5pm-close"

pkg/deadcheck/client.go

@@ -45,6 +45,16 @@ type CheckInResponse struct {
 	NextExpectedCheckIn time.Time `json:"nextExpectedCheckIn"`
 }
 
+// CheckIn updates the specified check's next expected alert time by extending it to the next scheduled interval.
+// This function is typically called after an operation successfully completes. For example, after files are uploaded.
+//
+// Example usage:
+//
+//	response, err := client.CheckIn(ctx, "2pm-checkin")
+//	if err != nil {
+//	    log.Fatalf("Failed to check in: %v", err)
+//	}
+//	log.Printf("Check-in successful: next check-in expected by %v", response.NextExpectedCheckIn)
 func (c *client) CheckIn(ctx context.Context, checkID string) (*CheckInResponse, error) {
 	address, err := c.getAddress(fmt.Sprintf("/checks/%s/check-in", checkID))
 	if err != nil {