chore: deprecate package (phrase#37)

package deprecation in favor of i18next-phrase-in-context-editor-post-processor add deprecation notice to README.md add deprecation console.log notification add deprecation notice to package.json description
stockx · Aug 18, 2020 · a20c492 · a20c492
1 parent ae0870a
commit a20c492
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,11 @@
-# react-i18next-phraseapp
+# DEPRECATED react-i18next-phraseapp
 
 ![Build status](https://github.com/phrase/react-i18next-phraseapp/workflows/Test/badge.svg)
+[![No Maintenance Intended](https://unmaintained.tech/badge.svg)](http://unmaintained.tech/)
+
+> This package has been deprecated in favor of [I18next Phrase In-Context Editor Post Processor](https://www.npmjs.com/package/i18next-phrase-in-context-editor-post-processor). Please have a look at [the documentation](https://phrase.github.io/i18next-phrase-in-context-editor-post-processor/examples/#react-i18next) for examples on how it can be used with React applications.
+
+## Original Readme
 
 This library lets you integrate the [PhraseApp In-Context Editor](https://help.phraseapp.com/translate-website-and-app-content/use-in-context-editor-to-translate/translate-directly-on-your-website) easily with your React apps localized with [react-i18next](https://github.com/i18next/react-i18next).
 

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "react-i18next-phraseapp",
-  "version": "2.0.2",
-  "description": "Connect react-i18next with the Phrase In-Context Editor",
+  "version": "2.0.3",
+  "description": "DEPRECATED ⛔️ Connect react-i18next with the Phrase In-Context Editor",
   "homepage": "https://phrase.com",
   "main": "./dist/react-i18next-phraseapp.js",
   "typings": "./dist/index.d.ts",
@@ -18,6 +18,7 @@
     "url": "https://github.com/phrase/react-i18next-phraseapp.git"
   },
   "keywords": [
+    "deprecated",
     "phrase",
     "phraseapp",
     "i18n",

diff --git a/src/index.ts b/src/index.ts
@@ -4,3 +4,4 @@ import withNamespaces from './with_namespaces';
 
 export { withNamespaces, PhraseAppInitializer, PhraseAppProvider, };
 
+console?.log?.('This package has been deprecated. Consider migrating to i18next-phrase-in-context-editor-post-processor instead (https://www.npmjs.com/package/i18next-phrase-in-context-editor-post-processor).');
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,3 +4,4 @@ import withNamespaces from './with_namespaces';

		export { withNamespaces, PhraseAppInitializer, PhraseAppProvider, };

		console?.log?.('This package has been deprecated. Consider migrating to i18next-phrase-in-context-editor-post-processor instead (https://www.npmjs.com/package/i18next-phrase-in-context-editor-post-processor).');