Merge pull request #203 from defi-wonderland/docs/soft-deprecate

docs: document deprecation

Author: 0xteddybear

.github/workflows/lint.yml

@@ -13,7 +13,7 @@ jobs:
           fetch-depth: 1
 
       - name: Cache node modules
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         env:
           cache-name: cache-node-modules
         with:

.github/workflows/tests.yml

@@ -16,7 +16,7 @@ jobs:
           fetch-depth: 1
 
       - name: Cache node modules
-        uses: actions/cache@v2
+        uses: actions/cache@v4
         env:
           cache-name: cache-node-modules
         with:

README.md

@@ -10,6 +10,19 @@
 <br />
 <br />
 
+## Soft-deprecation notice
+
+Smock has had a fruitful life, and its legacy lives on
+[smock-foundry](https://github.com/defi-wonderland/smock-foundry), a
+re-implementation for foundry which we now use exclusively as a side-effect of
+using `foundry` for all new projects.
+
+This project will receive security/bug fixes and code review for the
+foreseeable future, so existing projects can continue to use it, but no further
+features will be implemented. In particular, we won't migrate the project to
+newer versions of peer dependencies, as specified in
+[#201](https://github.com/defi-wonderland/smock/issues/201)
+
 **Smock** is the **S**olidity **mock**ing library. It's a plugin for
 [hardhat](https://hardhat.org) that can be used to create mock Solidity
 contracts entirely in JavaScript (or TypeScript!). With Smock, it's