Add deprecated warning

yoriiis · May 23, 2023 · 6a6ab75 · 6a6ab75
1 parent 096de96
commit 6a6ab75
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/.markdownlint.yml b/.markdownlint.yml
@@ -1,3 +1,4 @@
 MD013: false     # line-length
 MD024: false     # Multiple headers with the same content
 MD036: false     # no-emphasis-as-heading
+MD041: false     # First line in file should be a top level heading (for deprecated warning)
diff --git a/README.md b/README.md
@@ -1,3 +1,5 @@
+> **Warning** `step-manager` is deprecated and has been merged into the `costrojs` project. See [Costrojs](https://github.com/costrojs/costro) for its successor 🎉
+
 # StepManager
 
 ![StepManager](https://img.shields.io/badge/step--manager-v1.2.1-ff004b.svg?style=for-the-badge) ![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/yoriiis/step-manager/build.yml?branch=master&style=for-the-badge) [![Coverage Status](https://img.shields.io/coveralls/github/yoriiis/step-manager?style=for-the-badge)](https://coveralls.io/github/yoriiis/step-manager?branch=master)  ![Node.js](https://img.shields.io/node/v/step-manager?style=for-the-badge)