docs: update README for netresearch/go-cron fork

- Update badges and import paths for the fork
- Document panic fixes (issues robfig#554, robfig#555, robfig#551)
- Document DST handling improvements (PR robfig#541)
- Update Go version requirement to 1.25
- Simplify and modernize documentation structure

Author: CybotTM

README.md

@@ -1,46 +1,54 @@
-[![GoDoc](http://godoc.org/github.com/robfig/cron?status.png)](http://godoc.org/github.com/robfig/cron)
-[![Build Status](https://travis-ci.org/robfig/cron.svg?branch=master)](https://travis-ci.org/robfig/cron)
+[![Go Reference](https://pkg.go.dev/badge/github.com/netresearch/go-cron.svg)](https://pkg.go.dev/github.com/netresearch/go-cron)
 
-# cron
+# go-cron
 
-Cron V3 has been released!
+A maintained fork of [robfig/cron](https://github.com/robfig/cron) with bug fixes and improvements.
+
+## Installation
 
-To download the specific tagged release, run:
 ```bash
-go get github.com/robfig/cron/[email protected]
+go get github.com/netresearch/go-cron
 ```
+
 Import it in your program as:
 ```go
-import "github.com/robfig/cron/v3"
+import "github.com/netresearch/go-cron"
 ```
-It requires Go 1.11 or later due to usage of Go Modules.
 
-Refer to the documentation here:
-http://godoc.org/github.com/robfig/cron
+Requires Go 1.25 or later.
 
-The rest of this document describes the the advances in v3 and a list of
-breaking changes for users that wish to upgrade from an earlier version.
+## Why This Fork?
 
-## Upgrading to v3 (June 2019)
+The original robfig/cron has been unmaintained since 2020, with 50+ open PRs and several
+critical panic bugs. This fork addresses:
 
-cron v3 is a major upgrade to the library that addresses all outstanding bugs,
-feature requests, and rough edges. It is based on a merge of master which
-contains various fixes to issues found over the years and the v2 branch which
-contains some backwards-incompatible features like the ability to remove cron
-jobs. In addition, v3 adds support for Go Modules, cleans up rough edges like
-the timezone support, and fixes a number of bugs.
+- **Panic fixes**: Fixed TZ= parsing panics (issues #554, #555)
+- **Chain behavior**: Added `Entry.Run()` method to properly invoke chain decorators (issue #551)
+- **DST handling**: Jobs scheduled during DST "spring forward" now run immediately (ISC cron behavior, PR #541)
+- **Go 1.25**: Updated to latest Go version with modern toolchain
 
-New features:
+## Migrating from robfig/cron
 
-- Support for Go modules. Callers must now import this library as
-  `github.com/robfig/cron/v3`, instead of `gopkg.in/...`
+Simply update your import path:
+```go
+// Before
+import "github.com/robfig/cron/v3"
+
+// After
+import cron "github.com/netresearch/go-cron"
+```
 
-- Fixed bugs:
-  - 0f01e6b parser: fix combining of Dow and Dom (#70)
-  - dbf3220 adjust times when rolling the clock forward to handle non-existent midnight (#157)
-  - eeecf15 spec_test.go: ensure an error is returned on 0 increment (#144)
-  - 70971dc cron.Entries(): update request for snapshot to include a reply channel (#97)
-  - 1cba5e6 cron: fix: removing a job causes the next scheduled job to run too late (#206)
+The API is fully compatible with robfig/cron v3.
+
+## Documentation
+
+Refer to the [package documentation](https://pkg.go.dev/github.com/netresearch/go-cron).
+
+## Features (inherited from robfig/cron v3)
+
+This fork maintains full compatibility with robfig/cron v3 while adding fixes.
+
+Original v3 features:
 
 - Standard cron spec parsing by default (first field is "minute"), with an easy
   way to opt into the seconds field (quartz-compatible). Although, note that the
@@ -57,14 +65,8 @@ New features:
   - Log each job's invocations
   - Notification when jobs are completed
 
-It is backwards incompatible with both v1 and v2. These updates are required:
-
-- The v1 branch accepted an optional seconds field at the beginning of the cron
-  spec. This is non-standard and has led to a lot of confusion. The new default
-  parser conforms to the standard as described by [the Cron wikipedia page].
+## Usage Examples
 
-  UPDATING: To retain the old behavior, construct your Cron with a custom
-  parser:
 ```go
 // Seconds field, required
 cron.New(cron.WithSeconds())
@@ -73,40 +75,26 @@ cron.New(cron.WithSeconds())
 cron.New(cron.WithParser(cron.NewParser(
 	cron.SecondOptional | cron.Minute | cron.Hour | cron.Dom | cron.Month | cron.Dow | cron.Descriptor,
 )))
-```
-- The Cron type now accepts functional options on construction rather than the
-  previous ad-hoc behavior modification mechanisms (setting a field, calling a setter).
-
-  UPDATING: Code that sets Cron.ErrorLogger or calls Cron.SetLocation must be
-  updated to provide those values on construction.
-
-- CRON_TZ is now the recommended way to specify the timezone of a single
-  schedule, which is sanctioned by the specification. The legacy "TZ=" prefix
-  will continue to be supported since it is unambiguous and easy to do so.
-
-  UPDATING: No update is required.
 
-- By default, cron will no longer recover panics in jobs that it runs.
-  Recovering can be surprising (see issue #192) and seems to be at odds with
-  typical behavior of libraries. Relatedly, the `cron.WithPanicLogger` option
-  has been removed to accommodate the more general JobWrapper type.
-
-  UPDATING: To opt into panic recovery and configure the panic logger:
-```go
+// With panic recovery
 cron.New(cron.WithChain(
-  cron.Recover(logger),  // or use cron.DefaultLogger
+  cron.Recover(logger),
 ))
-```
-- In adding support for https://github.com/go-logr/logr, `cron.WithVerboseLogger` was
-  removed, since it is duplicative with the leveled logging.
 
-  UPDATING: Callers should use `WithLogger` and specify a logger that does not
-  discard `Info` logs. For convenience, one is provided that wraps `*log.Logger`:
-```go
+// With verbose logging
 cron.New(
   cron.WithLogger(cron.VerbosePrintfLogger(logger)))
 ```
 
+## Timezone Support
+
+CRON_TZ is the recommended way to specify the timezone of a single schedule:
+```
+CRON_TZ=America/New_York 0 0 * * *
+```
+
+The legacy "TZ=" prefix is also supported.
+
 ### Background - Cron spec format
 
 There are two cron spec formats in common usage: