From 089a1b74a3a9e7677d332d27fff2fa8637090a65 Mon Sep 17 00:00:00 2001 From: joostdecock Date: Tue, 23 Aug 2022 13:30:48 +0200 Subject: [PATCH] chore: Added deprecation warning to READMEs --- packages/components/README.md | 4 ++++ packages/components/info.md | 4 ++++ packages/css-theme/README.md | 4 ++++ packages/css-theme/info.md | 4 ++++ packages/gatsby-remark-jargon/README.md | 4 ++++ packages/gatsby-remark-jargon/info.md | 4 ++++ packages/mui-theme/README.md | 3 +++ packages/mui-theme/info.md | 3 +++ packages/pattern-info/README.md | 4 ++++ packages/pattern-info/info.md | 4 ++++ packages/remark-jargon/README.md | 5 +++++ packages/remark-jargon/info.md | 5 +++++ packages/utils/README.md | 4 ++++ packages/utils/info.md | 4 ++++ plugins/plugin-export-dxf/README.md | 4 ++++ plugins/plugin-export-dxf/info.md | 4 ++++ plugins/plugin-validate/README.md | 4 ++++ plugins/plugin-validate/info.md | 4 ++++ 18 files changed, 72 insertions(+) create mode 100644 packages/components/info.md create mode 100644 packages/css-theme/info.md create mode 100644 packages/pattern-info/info.md create mode 100644 packages/utils/info.md create mode 100644 plugins/plugin-validate/info.md diff --git a/packages/components/README.md b/packages/components/README.md index ed427113e0d..57f5cae62dc 100644 --- a/packages/components/README.md +++ b/packages/components/README.md @@ -50,6 +50,10 @@ A collection of React components for FreeSewing web UIs +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. + ## What am I looking at? 🤔 diff --git a/packages/components/info.md b/packages/components/info.md new file mode 100644 index 00000000000..2201ea27009 --- /dev/null +++ b/packages/components/info.md @@ -0,0 +1,4 @@ +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. + diff --git a/packages/css-theme/README.md b/packages/css-theme/README.md index f5c13fb6db7..03cab81d069 100644 --- a/packages/css-theme/README.md +++ b/packages/css-theme/README.md @@ -50,6 +50,10 @@ A CSS theme for FreeSewing web UIs +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. + ## What am I looking at? 🤔 diff --git a/packages/css-theme/info.md b/packages/css-theme/info.md new file mode 100644 index 00000000000..2201ea27009 --- /dev/null +++ b/packages/css-theme/info.md @@ -0,0 +1,4 @@ +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. + diff --git a/packages/gatsby-remark-jargon/README.md b/packages/gatsby-remark-jargon/README.md index 30f80bdf1b3..f86ddac7827 100644 --- a/packages/gatsby-remark-jargon/README.md +++ b/packages/gatsby-remark-jargon/README.md @@ -50,6 +50,10 @@ A gatsby-transformer-remark sub-plugin for jargon terms +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. + ## About This wraps the [remark-jargon](https://github.com/freesewing/freesewing/tree/develop/packages/remark-jargon) plugin diff --git a/packages/gatsby-remark-jargon/info.md b/packages/gatsby-remark-jargon/info.md index 1134a9f1aa9..6c95508771c 100644 --- a/packages/gatsby-remark-jargon/info.md +++ b/packages/gatsby-remark-jargon/info.md @@ -1,3 +1,7 @@ +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. + ## About This wraps the [remark-jargon](https://github.com/freesewing/freesewing/tree/develop/packages/remark-jargon) plugin diff --git a/packages/mui-theme/README.md b/packages/mui-theme/README.md index b7d4217b3af..95afdb4155f 100644 --- a/packages/mui-theme/README.md +++ b/packages/mui-theme/README.md @@ -50,6 +50,9 @@ A Material-UI theme for FreeSewing web UIs +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. ## Getting the theme diff --git a/packages/mui-theme/info.md b/packages/mui-theme/info.md index 821eb32e5bf..aea7e9001c7 100644 --- a/packages/mui-theme/info.md +++ b/packages/mui-theme/info.md @@ -1,3 +1,6 @@ +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. ## Getting the theme diff --git a/packages/pattern-info/README.md b/packages/pattern-info/README.md index b1f3605387e..14c23747f70 100644 --- a/packages/pattern-info/README.md +++ b/packages/pattern-info/README.md @@ -50,6 +50,10 @@ Information about available freesewing patterns +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. + ## What am I looking at? 🤔 diff --git a/packages/pattern-info/info.md b/packages/pattern-info/info.md new file mode 100644 index 00000000000..2201ea27009 --- /dev/null +++ b/packages/pattern-info/info.md @@ -0,0 +1,4 @@ +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. + diff --git a/packages/remark-jargon/README.md b/packages/remark-jargon/README.md index a1015f87361..5840749f207 100644 --- a/packages/remark-jargon/README.md +++ b/packages/remark-jargon/README.md @@ -50,6 +50,11 @@ A Remark plugin for jargon terms +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. +Please use [rehype-jargon](https://www.npmjs.com/package/rehype-jargon) instead. + ## About This [Remark](https://remark.js.org/) plugin allows you to use _jargon_ in your diff --git a/packages/remark-jargon/info.md b/packages/remark-jargon/info.md index c6b8d932844..511a144699d 100644 --- a/packages/remark-jargon/info.md +++ b/packages/remark-jargon/info.md @@ -1,3 +1,8 @@ +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. +Please use [rehype-jargon](https://www.npmjs.com/package/rehype-jargon) instead. + ## About This [Remark](https://remark.js.org/) plugin allows you to use _jargon_ in your diff --git a/packages/utils/README.md b/packages/utils/README.md index 01d9e8f3e7d..64ae6e80816 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -50,6 +50,10 @@ A collection of utilities shared across freesewing projects +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. + ## What am I looking at? 🤔 diff --git a/packages/utils/info.md b/packages/utils/info.md new file mode 100644 index 00000000000..2201ea27009 --- /dev/null +++ b/packages/utils/info.md @@ -0,0 +1,4 @@ +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. + diff --git a/plugins/plugin-export-dxf/README.md b/plugins/plugin-export-dxf/README.md index d76a65f1f9d..f19ae177d26 100644 --- a/plugins/plugin-export-dxf/README.md +++ b/plugins/plugin-export-dxf/README.md @@ -50,6 +50,10 @@ A FreeSewing plugin to export your pattern as DXF-ASTM +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. + ## About This plugin adds the ability to export patterns to DXF-ASTM. diff --git a/plugins/plugin-export-dxf/info.md b/plugins/plugin-export-dxf/info.md index 4dc3580ef35..53930f6a640 100644 --- a/plugins/plugin-export-dxf/info.md +++ b/plugins/plugin-export-dxf/info.md @@ -1,3 +1,7 @@ +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. + ## About This plugin adds the ability to export patterns to DXF-ASTM. diff --git a/plugins/plugin-validate/README.md b/plugins/plugin-validate/README.md index db7b13a6a29..2ba05a5e5a4 100644 --- a/plugins/plugin-validate/README.md +++ b/plugins/plugin-validate/README.md @@ -50,6 +50,10 @@ A FreeSewing plugin that validates aspects of your code +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. + ## What am I looking at? 🤔 diff --git a/plugins/plugin-validate/info.md b/plugins/plugin-validate/info.md new file mode 100644 index 00000000000..2201ea27009 --- /dev/null +++ b/plugins/plugin-validate/info.md @@ -0,0 +1,4 @@ +## 🚨🚨 This packages is deprecated 🚨🚨 + +This package will not be part of FreeSewing v3. +