Add deprecation notices to: library, readme, docs, CLI (#1)

* Add deprecation notices to: library, readme, docs, CLI

* rm yarn.lock from .gitignore

* Update README.md

Co-authored-by: charliecruzan-stripe <[email protected]>

* Update postinstall.js

Co-authored-by: charliecruzan-stripe <[email protected]>

* Update src/index.js

Co-authored-by: charliecruzan-stripe <[email protected]>

* Update website/docs-md/index.md

Co-authored-by: charliecruzan-stripe <[email protected]>

* Update website/docs-md/start.md

Co-authored-by: charliecruzan-stripe <[email protected]>

* Update website/docs-md/start.md

Co-authored-by: charliecruzan-stripe <[email protected]>

* Update website/docs-md/index.md

Co-authored-by: charliecruzan-stripe <[email protected]>

* Update website/docs/pages/en/index.js

Co-authored-by: charliecruzan-stripe <[email protected]>

* Update website/docs/pages/en/index.js

Co-authored-by: charliecruzan-stripe <[email protected]>

Co-authored-by: charliecruzan-stripe <[email protected]>

Author: 2 people

README.md

@@ -1,9 +1,8 @@
-# tipsi-stripe
-
-This library isn't actively maintained now. Please, consider usage of Stripe's official library:
+# 🚨 This library is no longer maintained 🚨
 
-https://github.com/stripe/stripe-react-native
+If you're building apps with React Native, please use [Stripe's official React Native library](https://github.com/stripe/stripe-react-native).
 
+# tipsi-stripe
 
 If for some reason you cannot migrate to it now. And you can offer with testing new beta versions, please reach me in [discord](https://discord.gg/vmBxnBw) (name: cybergrind#4625). Just PM with github account name + platforms you can check will be enough.
 I will ping you when we have something to check.

package.json

@@ -11,7 +11,8 @@
     "lint": "eslint",
     "lint:fix": "eslint --fix",
     "prettier": "prettier",
-    "prettier:js": "prettier --write src/*.{js,jsx} src/**/*.{js,jsx} example/src/*.{js,jsx} example/src/**/*.{js,jsx}"
+    "prettier:js": "prettier --write src/*.{js,jsx} src/**/*.{js,jsx} example/src/*.{js,jsx} example/src/**/*.{js,jsx}",
+    "postinstall": "node postinstall.js"
   },
   "repository": {
     "type": "git",

postinstall.js

@@ -0,0 +1,4 @@
+/* eslint-disable no-console */
+console.warn(
+  '🚨 [tipsi-stripe] Deprecation notice: tipsi-stripe is no longer maintained. Please migrate your project to @stripe/stripe-react-native: https://github.com/stripe/stripe-react-native'
+);

src/index.js

@@ -5,3 +5,8 @@ import errorCodes from './errorCodes'
 export { PaymentCardTextField, errorCodes }
 
 export default Stripe
+
+// eslint-disable-next-line no-console
+console.warn(
+  '🚨 [tipsi-stripe] Deprecation notice: tipsi-stripe is no longer maintained. Please migrate your project to @stripe/stripe-react-native: https://github.com/stripe/stripe-react-native'
+)

website/docs-md/index.md

@@ -1,27 +1,9 @@
 ---
 id: index
-title: Start here
-sidebar_label: Start here
+title: Deprecation Notice
+sidebar_label: Deprecation Notice
 ---
 
-## Library requirements
-### iOS
-
-* Xcode 8+
-
-* iOS 11+
-
-* [CocoaPods](https://cocoapods.org) 1.1.1+
-
-### Android
-
-* SDK 17+
-
-## Testing Payments
-
-**Credit Cards**: you can use real cards for payments on test environment without hesitation. You won't be charged on test environment for card payments.
-
-Or you can use [test cards provided by stripe](https://stripe.com/docs/testing#cards).
-
-**Google Pay**: will charge you for $1 but return money soon (~1hr).
+## 🚨 Deprecation notice: please use `@stripe/stripe-react-native` 🚨
 
+This library is no longer maintained. Please update your project to use [`@stripe/stripe-react-native`](https://github.com/stripe/stripe-react-native)

website/docs-md/start.md

@@ -0,0 +1,31 @@
+---
+id: start
+title: (Deprecated) Start here
+sidebar_label: (Deprecated) Start here
+---
+
+## 🚨 Deprecation notice: please use `@stripe/stripe-react-native` 🚨
+
+This library is no longer maintained. Please update your project to use [`@stripe/stripe-react-native`](https://github.com/stripe/stripe-react-native)
+
+## Library requirements
+
+### iOS
+
+- Xcode 8+
+
+- iOS 11+
+
+- [CocoaPods](https://cocoapods.org) 1.1.1+
+
+### Android
+
+- SDK 17+
+
+## Testing Payments
+
+**Credit Cards**: you can use real cards for payments on test environment without hesitation. You won't be charged on test environment for card payments.
+
+Or you can use [test cards provided by stripe](https://stripe.com/docs/testing#cards).
+
+**Google Pay**: will charge you for \$1 but return money soon (~1hr).

website/docs/i18n/en.json

@@ -3,7 +3,7 @@
   "localized-strings": {
     "next": "Next",
     "previous": "Previous",
-    "tagline": "Stripe support for React-Native",
+    "tagline": "(Deprecated) Stripe support for React-Native",
     "docs": {
       "cancelapplepayrequest": {
         "title": ".cancelApplePayRequest() -> Promise",
@@ -82,8 +82,8 @@
         "sidebar_label": "Google Pay"
       },
       "index": {
-        "title": "Start here",
-        "sidebar_label": "Start here"
+        "title": "Deprecation Notice",
+        "sidebar_label": "Deprecation Notice"
       },
       "installation": {
         "title": "Installation",
@@ -145,6 +145,10 @@
         "title": "Source",
         "sidebar_label": "Source"
       },
+      "start": {
+        "title": "(Deprecated) Start here",
+        "sidebar_label": "(Deprecated) Start here"
+      },
       "tests-local-ci": {
         "title": "Local CI",
         "sidebar_label": "Local CI"
@@ -179,8 +183,7 @@
       }
     },
     "links": {
-      "Docs": "Docs",
-      "Blog": "Blog"
+      "Docs": "Docs"
     },
     "categories": {
       "Overview": "Overview",

website/docs/pages/en/index.js

@@ -5,18 +5,18 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const React = require('react')
-const PropTypes = require('prop-types')
-const { Container, GridBlock } = require('../../core/CompLibrary')
+const React = require('react');
+const PropTypes = require('prop-types');
+const { Container, GridBlock } = require('../../core/CompLibrary');
 
-const siteConfig = require(process.cwd() + '/siteConfig') // eslint-disable-line
+const siteConfig = require(process.cwd() + '/siteConfig'); // eslint-disable-line
 
 function imgUrl(img) {
-  return `${siteConfig.baseUrl}img/${img}`
+  return `${siteConfig.baseUrl}img/${img}`;
 }
 
 function pageUrl(page, language) {
-  return `${siteConfig.baseUrl}${language ? `${language}/` : ''}${page}`
+  return `${siteConfig.baseUrl}${language ? `${language}/` : ''}${page}`;
 }
 
 class Button extends React.Component {
@@ -27,50 +27,50 @@ class Button extends React.Component {
           {this.props.children}
         </a>
       </div>
-    )
+    );
   }
 }
 
 Button.propTypes = {
   href: PropTypes.string.isRequired,
   children: PropTypes.any.isRequired,
-  target: PropTypes.string,
-}
+  target: PropTypes.string
+};
 
 Button.defaultProps = {
-  target: '_self',
-}
+  target: '_self'
+};
 
 const SplashContainer = props => (
   <div className="homeContainer">
     <div className="homeSplashFade">
       <div className="wrapper homeWrapper">{props.children}</div>
     </div>
   </div>
-)
+);
 
 SplashContainer.propTypes = {
-  children: PropTypes.any.isRequired,
-}
+  children: PropTypes.any.isRequired
+};
 
 const ProjectTitle = () => (
   <h2 className="projectTitle">
     {siteConfig.title}
     <small>{siteConfig.tagline}</small>
   </h2>
-)
+);
 
 const PromoSection = props => (
   <div className="section promoSection">
     <div className="promoRow">
       <div className="pluginRowBlock">{props.children}</div>
     </div>
   </div>
-)
+);
 
 PromoSection.propTypes = {
-  children: PropTypes.any.isRequired,
-}
+  children: PropTypes.any.isRequired
+};
 
 class HomeSplash extends React.Component {
   render() {
@@ -79,32 +79,32 @@ class HomeSplash extends React.Component {
         <div className="inner">
           <ProjectTitle />
           <PromoSection>
-            <Button href="https://github.com/tipsi/tipsi-stripe/tree/master/example">
-              Sample Project
+            <Button href="https://github.com/stripe/stripe-react-native">
+              Official library: @stripe/stripe-react-native
             </Button>
           </PromoSection>
         </div>
       </SplashContainer>
-    )
+    );
   }
 }
 
 const Block = props => (
   <Container padding={['bottom', 'top']} id={props.id} background={props.background}>
     <GridBlock align="center" contents={props.children} layout={props.layout} />
   </Container>
-)
+);
 
 Block.propTypes = {
   id: PropTypes.string.isRequired,
   background: PropTypes.string.isRequired,
   children: PropTypes.any.isRequired,
-  layout: PropTypes.string.isRequired,
-}
+  layout: PropTypes.string.isRequired
+};
 
-const Showcase = (props) => {
+const Showcase = props => {
   if ((siteConfig.users || []).length === 0) {
-    return null
+    return null;
   }
 
   const showcase = siteConfig.users
@@ -113,29 +113,36 @@ const Showcase = (props) => {
       <a href={user.infoLink} key={user.caption}>
         <img src={user.image} title={user.caption} alt={user.caption} />
       </a>
-    ))
+    ));
 
   return (
-      <div className="productShowcaseSection paddingBottom">
+    <div className="productShowcaseSection paddingBottom">
       <h2>Quick navigation</h2>
-      <a href="/tipsi-stripe/docs/index.html">Start reading docs</a>
+      <p>
+        <a href="https://github.com/stripe/stripe-react-native">
+          Official library: @stripe/stripe-react-native
+        </a>
+      </p>
+      <p>
+        <a href="/tipsi-stripe/docs/index.html">(Deprecated) Start reading docs</a>
+      </p>
 
       <div className="logos">{showcase}</div>
     </div>
-  )
-}
+  );
+};
 
 Showcase.propTypes = {
-  language: PropTypes.string,
-}
+  language: PropTypes.string
+};
 
 Showcase.defaultProps = {
-  language: undefined,
-}
+  language: undefined
+};
 
 class Index extends React.Component {
   render() {
-    const { language = '' } = this.props
+    const { language = '' } = this.props;
 
     return (
       <div>
@@ -144,16 +151,16 @@ class Index extends React.Component {
           <Showcase language={language} />
         </div>
       </div>
-    )
+    );
   }
 }
 
 Index.propTypes = {
-  language: PropTypes.string,
-}
+  language: PropTypes.string
+};
 
 Index.defaultProps = {
-  language: undefined,
-}
+  language: undefined
+};
 
-module.exports = Index
+module.exports = Index;

website/docs/sidebars.json

@@ -2,6 +2,7 @@
   "docs": {
     "Overview": [
       "index",
+      "start",
       "compatibility",
       "installation",
       "linking",
@@ -14,11 +15,7 @@
       "migrationIssues",
       "changelog"
     ],
-    "Objects": [
-      "token",
-      "source",
-      "paymentMethod"
-    ],
+    "Objects": ["token", "source", "paymentMethod"],
     "Native Pay -  & G": [
       "canMakeNativePayPayments",
       "deviceSupportsNativePay",
@@ -32,10 +29,7 @@
     "Create Source Object With Params": ["createsourcewithparamsparams"],
     "Components": ["paymentcardtextfield"],
     "Error Codes": ["errorcodes"],
-    "Tests": [
-      "tests-local-ci",
-      "tests-manual"
-    ],
+    "Tests": ["tests-local-ci", "tests-manual"],
     "Troubleshooting": [
       "troubleshooting-android",
       "troubleshooting-jest",