From e59e084e7ef68993f63748495e0f0207f95ae465 Mon Sep 17 00:00:00 2001
From: GitHub Action <action@github.com>
Date: Tue, 18 Jun 2024 10:05:55 +0000
Subject: [PATCH] Automatic readme update

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index 567e114..cfc6a91 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,8 @@
 
 <!-- badges: start -->
 
+[![Lifecycle:
+retired](https://img.shields.io/badge/lifecycle-retired-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#retired)
 ![GitHub R package
 version](https://img.shields.io/github/r-package/v/epiverse-trace/bpmodels)
 [![R-CMD-check](https://github.com/epiverse-trace/bpmodels/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/epiverse-trace/bpmodels/actions/workflows/R-CMD-check.yaml)
@@ -13,6 +15,15 @@ contributors](https://img.shields.io/github/contributors/epiverse-trace/bpmodels
 MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/license/MIT/)
 <!-- badges: end -->
 
+## Note
+
+> `{bpmodels}` is now *retired and will no longer be maintained*. We
+> recommend using
+> [`{epichains}`](https://github.com/epiverse-trace/epichains) instead.
+> If you need help converting your code to use `{epichains}`, please
+> [open a discussion on
+> epichains](https://github.com/epiverse-trace/epichains/discussions).
+
 *bpmodels* is an R package to simulate and analyse the size and length
 of branching processes with a given offspring distribution. These models
 are often used in infectious disease epidemiology, where the chains
@@ -35,6 +46,7 @@ To load the package, use
 
 ``` r
 library("bpmodels")
+#> Note: bpmodels is now retired and replaced by epichains. All features from bpmodels are available in epichains. Get epichains from <https://github.com/epiverse-trace/epichains>.Thank you for your support!
 ```
 
 # Core functionality