From 0239947e93974b44cc059f17b940e03fa0092275 Mon Sep 17 00:00:00 2001
From: Jennifer Hasegawa <5481259+jhaaaa@users.noreply.github.com>
Date: Wed, 15 Jan 2025 18:07:05 -0800
Subject: [PATCH] add deprecation note

---
 README.md | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 5c0a1a1..c2cbae1 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,16 @@
-![https://github.com/xmtp/bot-kit-pro/actions/workflows/test.yml/badge.svg](https://github.com/xmtp/bot-kit-pro/actions/workflows/test.yml/badge.svg) ![https://github.com/xmtp/bot-kit-pro/actions/workflows/lint.yml/badge.svg](https://github.com/xmtp/bot-kit-pro/actions/workflows/lint.yml/badge.svg) ![Status](https://img.shields.io/badge/Project_status-Alpha-orange)
-
 # XMTP Node.js tools
 
+![Status](https://img.shields.io/badge/Deprecated-brown)
+
+> [!CAUTION]
+> The XMTP Node.js tools are no longer maintained.
+
+For your Frames project, consider using the tools in [xmtp-js packages](https://github.com/xmtp/xmtp-js/tree/main/packages). These updated tools provide enhanced functionality and are designed to provide better support for your development needs.
+
+The content below is provided for historical reference only.
+
+---
+
 This repo provides a collection of tools for running high-quality XMTP bots in Node.js. It contains the following packages:
 
 - [Bot Kit Pro](./packages/bot-kit-pro/README.md): `Bot Kit Pro` is a framework for running bots on the XMTP network designed for complex workflows that require high reliability.