From b78e4e23070739918aee42c19df4f3c9f80f80d7 Mon Sep 17 00:00:00 2001
From: Michael Peyper <michael.peyper@ioof.com.au>
Date: Wed, 27 Jan 2021 11:51:50 +1100
Subject: [PATCH] Add deprecation to READMEs

Relates to #546
---
 ISSUE_TEMPLATE.md                            | 59 ++++----------------
 PULL_REQUEST_TEMPLATE.md                     | 28 ++++------
 README.md                                    | 20 +++++++
 packages/react-redux-subspace/README.md      | 20 +++++++
 packages/redux-subspace-loop/README.md       | 20 +++++++
 packages/redux-subspace-observable/README.md | 20 +++++++
 packages/redux-subspace-saga/README.md       | 20 +++++++
 packages/redux-subspace-wormhole/README.md   | 20 +++++++
 packages/redux-subspace/README.md            | 20 +++++++
 9 files changed, 164 insertions(+), 63 deletions(-)

diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
index 1a98cc77..d810befb 100644
--- a/ISSUE_TEMPLATE.md
+++ b/ISSUE_TEMPLATE.md
@@ -1,52 +1,17 @@
-<!---
-Thanks for contributing to this redux-subspace! Before you submit, please read the following:
+# Deprecated
 
-Search open/closed issues before submitting since someone might have asked the same thing before!
--->
+**This library is no longer being actively maintained.**
 
-### Is it a bug, feature request or question?
+IOOF has been slowly moving away from the ubiquitous use of Redux as a core piece of our micro-frontend architecture and have been actively replacing
+the usage of this library with more standard React and JavaScript patterns.  Due to some technical constraints, we've also been unable to upgrade to
+the latest version of the library ourselves for quite some time now, further fuelling our desire to move away from this solution.
 
-<!--- Provide a general summary of the issue in the title above -->
+At this time, we will be ceasing all maintenance tasks and we recommend that you consider using an alternative library:
 
-### Which package(s) does this involve?
+* [`redux-doghouse`](https://www.npmjs.com/package/redux-doghouse)
+* [`redux-fractal`](https://www.npmjs.com/package/redux-fractal)
+* [`lean-redux`](https://www.npmjs.com/package/lean-redux)
+* [`redux-react-local`](https://www.npmjs.com/package/redux-react-local)
+* [`multireducer`](https://www.npmjs.com/package/multireducer)
 
-<!--- Please postfix the title above with packages like so: "{TITLE} [package-1, package-2]" -->
-
-### Input Code
-
-<!--- If you're describing a bug, please let us know which sample code reproduces your problem -->
-<!--- Links to standalone repos or code sandboxes (https://codesandbox.io/ is great for this) are  also welcome -->
-
-```js
-// your code here
-```
-
-### Expected Behavior
-
-<!--- If you're describing a bug, tell us what should happen -->
-<!--- If you're suggesting a change/improvement, tell us how it should work -->
-
-### Current Behavior
-
-<!--- If describing a bug, tell us what happens instead of the expected behavior -->
-<!--- If suggesting a change/improvement, explain the difference from current behavior -->
-
-### Possible Solution
-
-<!--- Not obligatory, but suggest a fix/reason for the bug, or ideas how to implement the addition or change -->
-
-### Context
-
-<!--- How has this issue affected you? What are you trying to accomplish? -->
-<!--- Providing context helps us come up with a solution that is most useful in the real world -->
-
-### Your Setup
-
-<!--- Include as many relevant details about the setup you're using -->
-<!--- How you setup the store, what middleware/enhancers you're using, which versions of packages are involved -->
-
-| package        | version(s)
-| ---------------| -------
-| redux          |  
-| redux-subspace |
-| etc.           | 
+If you want to continue using this library, we encourage you to fork this repo and take over maintenance yourself.
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
index 0c3bedcc..f2a77f67 100644
--- a/PULL_REQUEST_TEMPLATE.md
+++ b/PULL_REQUEST_TEMPLATE.md
@@ -1,21 +1,17 @@
-<!--
-Thanks for contributing to redux-subspace!
+## Deprecated
 
-Before making a PR please make sure to read our contributing guidelines
-https://github.com/ioof-holdings/redux-subspace/blob/master/CONTRIBUTING.md
+**This library is no longer being actively maintained.**
 
-For issue references: Add a comma-separated list of a [closing word](https://help.github.com/articles/closing-issues-via-commit-messages/) followed by the ticket number fixed by the PR. It should be underlined in the preview if done correctly.
--->
+IOOF has been slowly moving away from the ubiquitous use of Redux as a core piece of our micro-frontend architecture and have been actively replacing
+the usage of this library with more standard React and JavaScript patterns.  Due to some technical constraints, we've also been unable to upgrade to
+the latest version of the library ourselves for quite some time now, further fuelling our desire to move away from this solution.
 
-| Q                       | A 
-| ----------------------- | ---
-| Fixed Issues?           | Fixes `#1`, Fixes `#2` <!-- remove the (`) quotes to link the issues -->
-| Documentation only PR   | <!--(Can use an emoji 👍) -->
-| Patch: Bug Fix?         | <!--(Can use an emoji 👍) -->
-| Minor: New Feature?     | <!--(Can use an emoji 👍) -->
-| Major: Breaking Change? | <!--(Can use an emoji 👍) -->
-| Tests Added + Pass?     | Yes
+At this time, we will be ceasing all maintenance tasks and we recommend that you consider using an alternative library:
 
-<!-- Describe your changes below in as much detail as possible -->
+* [`redux-doghouse`](https://www.npmjs.com/package/redux-doghouse)
+* [`redux-fractal`](https://www.npmjs.com/package/redux-fractal)
+* [`lean-redux`](https://www.npmjs.com/package/lean-redux)
+* [`redux-react-local`](https://www.npmjs.com/package/redux-react-local)
+* [`multireducer`](https://www.npmjs.com/package/multireducer)
 
-<!-- Don't forget to [add yourself as a contributor](https://github.com/ioof-holdings/redux-subspace/blob/master/CONTRIBUTING.md#add-yourself-as-a-contributor) if you're not already -->
+If you want to continue using this library, we encourage you to fork this repo and take over maintenance yourself.
diff --git a/README.md b/README.md
index 191680e8..daadef68 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,25 @@
 # redux-subspace
 
+## Deprecated
+
+**This library is no longer being actively maintained.**
+
+IOOF has been slowly moving away from the ubiquitous use of Redux as a core piece of our micro-frontend architecture and have been actively replacing
+the usage of this library with more standard React and JavaScript patterns.  Due to some technical constraints, we've also been unable to upgrade to
+the latest version of the library ourselves for quite some time now, further fuelling our desire to move away from this solution.
+
+At this time, we will be ceasing all maintenance tasks and we recommend that you consider using an alternative library:
+
+* [`redux-doghouse`](https://www.npmjs.com/package/redux-doghouse)
+* [`redux-fractal`](https://www.npmjs.com/package/redux-fractal)
+* [`lean-redux`](https://www.npmjs.com/package/lean-redux)
+* [`redux-react-local`](https://www.npmjs.com/package/redux-react-local)
+* [`multireducer`](https://www.npmjs.com/package/multireducer)
+
+If you want to continue using this library, we encourage you to fork this repo and take over maintenance yourself.
+
+---
+
 [![npm version](https://img.shields.io/npm/v/redux-subspace.svg?style=flat-square)](https://www.npmjs.com/package/redux-subspace)
 [![npm downloads](https://img.shields.io/npm/dm/redux-subspace.svg?style=flat-square)](https://www.npmjs.com/package/redux-subspace)
 [![License: BSD-3-Clause](https://img.shields.io/npm/l/redux-subspace.svg?style=flat-square)](/LICENSE.md)
diff --git a/packages/react-redux-subspace/README.md b/packages/react-redux-subspace/README.md
index 5648369a..93a03ac7 100644
--- a/packages/react-redux-subspace/README.md
+++ b/packages/react-redux-subspace/README.md
@@ -1,5 +1,25 @@
 # react-redux-subspace
 
+## Deprecated
+
+**This library is no longer being actively maintained.**
+
+IOOF has been slowly moving away from the ubiquitous use of Redux as a core piece of our micro-frontend architecture and have been actively replacing
+the usage of this library with more standard React and JavaScript patterns.  Due to some technical constraints, we've also been unable to upgrade to
+the latest version of the library ourselves for quite some time now, further fuelling our desire to move away from this solution.
+
+At this time, we will be ceasing all maintenance tasks and we recommend that you consider using an alternative library:
+
+* [`redux-doghouse`](https://www.npmjs.com/package/redux-doghouse)
+* [`redux-fractal`](https://www.npmjs.com/package/redux-fractal)
+* [`lean-redux`](https://www.npmjs.com/package/lean-redux)
+* [`redux-react-local`](https://www.npmjs.com/package/redux-react-local)
+* [`multireducer`](https://www.npmjs.com/package/multireducer)
+
+If you want to continue using this library, we encourage you to fork this repo and take over maintenance yourself.
+
+---
+
 [![npm version](https://img.shields.io/npm/v/react-redux-subspace.svg?style=flat-square)](https://www.npmjs.com/package/react-redux-subspace)
 [![npm downloads](https://img.shields.io/npm/dm/react-redux-subspace.svg?style=flat-square)](https://www.npmjs.com/package/react-redux-subspace)
 [![License: BSD-3-Clause](https://img.shields.io/npm/l/react-redux-subspace.svg?style=flat-square)](/LICENSE.md)
diff --git a/packages/redux-subspace-loop/README.md b/packages/redux-subspace-loop/README.md
index d3b9d4a6..4b01969c 100644
--- a/packages/redux-subspace-loop/README.md
+++ b/packages/redux-subspace-loop/README.md
@@ -1,5 +1,25 @@
 # redux-subspace-loop
 
+## Deprecated
+
+**This library is no longer being actively maintained.**
+
+IOOF has been slowly moving away from the ubiquitous use of Redux as a core piece of our micro-frontend architecture and have been actively replacing
+the usage of this library with more standard React and JavaScript patterns.  Due to some technical constraints, we've also been unable to upgrade to
+the latest version of the library ourselves for quite some time now, further fuelling our desire to move away from this solution.
+
+At this time, we will be ceasing all maintenance tasks and we recommend that you consider using an alternative library:
+
+* [`redux-doghouse`](https://www.npmjs.com/package/redux-doghouse)
+* [`redux-fractal`](https://www.npmjs.com/package/redux-fractal)
+* [`lean-redux`](https://www.npmjs.com/package/lean-redux)
+* [`redux-react-local`](https://www.npmjs.com/package/redux-react-local)
+* [`multireducer`](https://www.npmjs.com/package/multireducer)
+
+If you want to continue using this library, we encourage you to fork this repo and take over maintenance yourself.
+
+---
+
 [![npm version](https://img.shields.io/npm/v/redux-subspace-loop.svg?style=flat-square)](https://www.npmjs.com/package/redux-subspace-loop)
 [![npm downloads](https://img.shields.io/npm/dm/redux-subspace-loop.svg?style=flat-square)](https://www.npmjs.com/package/redux-subspace-loop)
 [![License: BSD-3-Clause](https://img.shields.io/npm/l/redux-subspace-loop.svg?style=flat-square)](/LICENSE.md)
diff --git a/packages/redux-subspace-observable/README.md b/packages/redux-subspace-observable/README.md
index e7abc333..25fd1143 100644
--- a/packages/redux-subspace-observable/README.md
+++ b/packages/redux-subspace-observable/README.md
@@ -1,5 +1,25 @@
 # redux-subspace-observable
 
+## Deprecated
+
+**This library is no longer being actively maintained.**
+
+IOOF has been slowly moving away from the ubiquitous use of Redux as a core piece of our micro-frontend architecture and have been actively replacing
+the usage of this library with more standard React and JavaScript patterns.  Due to some technical constraints, we've also been unable to upgrade to
+the latest version of the library ourselves for quite some time now, further fuelling our desire to move away from this solution.
+
+At this time, we will be ceasing all maintenance tasks and we recommend that you consider using an alternative library:
+
+* [`redux-doghouse`](https://www.npmjs.com/package/redux-doghouse)
+* [`redux-fractal`](https://www.npmjs.com/package/redux-fractal)
+* [`lean-redux`](https://www.npmjs.com/package/lean-redux)
+* [`redux-react-local`](https://www.npmjs.com/package/redux-react-local)
+* [`multireducer`](https://www.npmjs.com/package/multireducer)
+
+If you want to continue using this library, we encourage you to fork this repo and take over maintenance yourself.
+
+---
+
 [![npm version](https://img.shields.io/npm/v/redux-subspace-observable.svg?style=flat-square)](https://www.npmjs.com/package/redux-subspace-observable)
 [![npm downloads](https://img.shields.io/npm/dm/redux-subspace-observable.svg?style=flat-square)](https://www.npmjs.com/package/redux-subspace-observable)
 [![License: BSD-3-Clause](https://img.shields.io/npm/l/redux-subspace-observable.svg?style=flat-square)](/LICENSE.md)
diff --git a/packages/redux-subspace-saga/README.md b/packages/redux-subspace-saga/README.md
index ae837795..611104a6 100644
--- a/packages/redux-subspace-saga/README.md
+++ b/packages/redux-subspace-saga/README.md
@@ -1,5 +1,25 @@
 # redux-subspace-saga
 
+## Deprecated
+
+**This library is no longer being actively maintained.**
+
+IOOF has been slowly moving away from the ubiquitous use of Redux as a core piece of our micro-frontend architecture and have been actively replacing
+the usage of this library with more standard React and JavaScript patterns.  Due to some technical constraints, we've also been unable to upgrade to
+the latest version of the library ourselves for quite some time now, further fuelling our desire to move away from this solution.
+
+At this time, we will be ceasing all maintenance tasks and we recommend that you consider using an alternative library:
+
+* [`redux-doghouse`](https://www.npmjs.com/package/redux-doghouse)
+* [`redux-fractal`](https://www.npmjs.com/package/redux-fractal)
+* [`lean-redux`](https://www.npmjs.com/package/lean-redux)
+* [`redux-react-local`](https://www.npmjs.com/package/redux-react-local)
+* [`multireducer`](https://www.npmjs.com/package/multireducer)
+
+If you want to continue using this library, we encourage you to fork this repo and take over maintenance yourself.
+
+---
+
 [![npm version](https://img.shields.io/npm/v/redux-subspace-saga.svg?style=flat-square)](https://www.npmjs.com/package/redux-subspace-saga)
 [![npm downloads](https://img.shields.io/npm/dm/redux-subspace-saga.svg?style=flat-square)](https://www.npmjs.com/package/redux-subspace-saga)
 [![License: BSD-3-Clause](https://img.shields.io/npm/l/redux-subspace-saga.svg?style=flat-square)](/LICENSE.md)
diff --git a/packages/redux-subspace-wormhole/README.md b/packages/redux-subspace-wormhole/README.md
index 925d21a7..c6a92024 100644
--- a/packages/redux-subspace-wormhole/README.md
+++ b/packages/redux-subspace-wormhole/README.md
@@ -1,5 +1,25 @@
 # redux-subspace-wormhole
 
+## Deprecated
+
+**This library is no longer being actively maintained.**
+
+IOOF has been slowly moving away from the ubiquitous use of Redux as a core piece of our micro-frontend architecture and have been actively replacing
+the usage of this library with more standard React and JavaScript patterns.  Due to some technical constraints, we've also been unable to upgrade to
+the latest version of the library ourselves for quite some time now, further fuelling our desire to move away from this solution.
+
+At this time, we will be ceasing all maintenance tasks and we recommend that you consider using an alternative library:
+
+* [`redux-doghouse`](https://www.npmjs.com/package/redux-doghouse)
+* [`redux-fractal`](https://www.npmjs.com/package/redux-fractal)
+* [`lean-redux`](https://www.npmjs.com/package/lean-redux)
+* [`redux-react-local`](https://www.npmjs.com/package/redux-react-local)
+* [`multireducer`](https://www.npmjs.com/package/multireducer)
+
+If you want to continue using this library, we encourage you to fork this repo and take over maintenance yourself.
+
+---
+
 [![npm version](https://img.shields.io/npm/v/redux-subspace-wormhole.svg?style=flat-square)](https://www.npmjs.com/package/redux-subspace-wormhole)
 [![npm downloads](https://img.shields.io/npm/dm/redux-subspace-wormhole.svg?style=flat-square)](https://www.npmjs.com/package/redux-subspace-wormhole)
 [![License: BSD-3-Clause](https://img.shields.io/npm/l/redux-subspace-wormhole.svg?style=flat-square)](/LICENSE.md)
diff --git a/packages/redux-subspace/README.md b/packages/redux-subspace/README.md
index 03ad4db6..e40a75cd 100644
--- a/packages/redux-subspace/README.md
+++ b/packages/redux-subspace/README.md
@@ -1,5 +1,25 @@
 # redux-subspace
 
+## Deprecated
+
+**This library is no longer being actively maintained.**
+
+IOOF has been slowly moving away from the ubiquitous use of Redux as a core piece of our micro-frontend architecture and have been actively replacing
+the usage of this library with more standard React and JavaScript patterns.  Due to some technical constraints, we've also been unable to upgrade to
+the latest version of the library ourselves for quite some time now, further fuelling our desire to move away from this solution.
+
+At this time, we will be ceasing all maintenance tasks and we recommend that you consider using an alternative library:
+
+* [`redux-doghouse`](https://www.npmjs.com/package/redux-doghouse)
+* [`redux-fractal`](https://www.npmjs.com/package/redux-fractal)
+* [`lean-redux`](https://www.npmjs.com/package/lean-redux)
+* [`redux-react-local`](https://www.npmjs.com/package/redux-react-local)
+* [`multireducer`](https://www.npmjs.com/package/multireducer)
+
+If you want to continue using this library, we encourage you to fork this repo and take over maintenance yourself.
+
+---
+
 [![npm version](https://img.shields.io/npm/v/redux-subspace.svg?style=flat-square)](https://www.npmjs.com/package/redux-subspace)
 [![npm downloads](https://img.shields.io/npm/dm/redux-subspace.svg?style=flat-square)](https://www.npmjs.com/package/redux-subspace)
 [![License: BSD-3-Clause](https://img.shields.io/npm/l/redux-subspace.svg?style=flat-square)](/LICENSE.md)