From d4d6cf932f603198de5de2ac58e77576a33bbac4 Mon Sep 17 00:00:00 2001 From: Cedric van Putten Date: Wed, 5 Jun 2024 19:13:59 +0200 Subject: [PATCH] docs: add deprecation notice in readme --- README.md | 137 ++++++------------------------------ src/__tests__/index.test.js | 2 +- src/index.ts | 2 +- 3 files changed, 23 insertions(+), 118 deletions(-) diff --git a/README.md b/README.md index 26aa0a7..9ac5d9c 100644 --- a/README.md +++ b/README.md @@ -3,133 +3,38 @@

create-react-native-app -

Create React Native App

+

⚠️ Deprecated

- The fastest way to create React Native apps -
- -

- - Supports Expo iOS - - Supports Expo Android - - Supports Expo Web -

-

- - the best way to bootstrap a react native app - -

- -

- - - -```sh -npx create-react-native-app -``` - -Once you're up and running with Create React Native App, visit [the tutorial on reactnative.dev](https://reactnative.dev/docs/tutorial) and [the tutorial on expo.dev](https://docs.expo.dev/tutorial/introduction/) for more information on building mobile apps with React. - -

- Product: demo + It's recommended to use a framework to build apps with React Native, learn more.

-## Usage - -- `npx create-react-native-app` Create a new native React app. -- `npx crna` Alias for `npx create-react-native-app`. -- `npm run ios` -- (`npx expo run:ios`) Build the iOS App (requires a MacOS computer). -- `npm run android` -- (`npx expo run:android`) Build the Android App. -- `npm run web` -- (`npx expo start --web`) Run the website in your browser. - -### Templates - -By default you create a [bare workflow React](https://docs.expo.dev/bare/overview/) project with support for iOS, Android, and web. The project comes preconfigured with support for [Expo Modules](https://docs.expo.dev/modules/overview/), an API writing native modules using Swift and Kotlin, and this also makes it possible to use any library in the [Expo SDK](https://docs.expo.dev/versions/latest/). - -You can opt to use an example project instead by selecting the "Templates from ..." option. Custom templates can be used with `--template ` option. - -- Use an [example](https://github.com/expo/examples): `npx create-react-native-app -t with-typescript` -- Use a custom template: `npx create-react-native-app --template https://github.com/someone/my-react-starter` -- Only works with GitHub repos on the master branch. -- All examples can be modified in the [expo/examples](https://github.com/expo/examples) repo. - -## Sections - -- [Usage with Expo Go App](#usage-with-expo-go-app) -- [Support and Contact](#support-and-contact) -- [FAQs](#faqs) -- [Contributing](#contributing) - -## Usage with Expo Go App - -Expo Go enables you to work with all of the [Components and APIs](https://facebook.github.io/react-native/docs/getting-started) in `react-native`, as well as the [JavaScript APIs](https://docs.expo.io/versions/latest) that the are bundled with the Expo app. +
+
-- Download the "Expo Go" app from the Play Store or App Store. -- Start your project with Expo CLI: `npm start` -- Open the project by scanning the QR code in the terminal. - -## Support and Contact - -If you're having issues with Create React Native App, please make sure: - -- The issue is not covered in the [Expo Docs](https://docs.expo.io/versions/latest/) -- There is not already an [open issue](https://github.com/expo/create-react-native-app/issues/) for your particular problem - -If you've checked the documentation and currently open issues, please either [open a new GitHub issue](https://github.com/expo/create-react-native-app/issues/new) or ask a question on [Expo Community Discord](https://chat.expo.dev). - -## Contributing - -Refer to the [Contributing guide](https://github.com/expo/create-react-native-app/blob/main/CONTRIBUTING.md) for more information. - -### Attribution - -The examples feature was inspired by the `templates` system of [create-next-app](https://github.com/zeit/next.js/tree/canary/packages/create-next-app) by the [Vercel](https://vercel.com/) team. - -## Related - -CRNA is focused on being the fastest way to bootstrap a React Native app without worrying about the native platforms or bundlers required for developing and shipping apps. Other tools provide both an init script (which is slower) and a suite of other tools that can be used for interacting with the project. CRNA is meant to be used with any of the following tools: - -- [Expo CLI](https://docs.expo.dev/more/expo-cli/) by [Expo team](https://expo.dev) -- [Ignite CLI](https://github.com/infinitered/ignite) by [Infinite Red](https://infinite.red/) -- [React Native Community CLI](https://github.com/react-native-community/cli) by members of [the React Native community](https://github.com/orgs/react-native-community/people) - - - -## Contributors ✨ - - -[![All Contributors](https://img.shields.io/badge/all_contributors-8-orange.svg?style=flat-square)](#contributors-) - + -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): +## Deprecated - - - - - - - - - - - - - - - - -

Evan Bacon
💻 📖 🎨 🚧 👀
Brent Vatne
💻 📖 👀
Hamza Halilovic
💻
Cedric van Putten
💻
Ville Immonen
💻 👀
Frieder Bluemle
💻
Kim Brandwijk
💻

Nirav
💻
+Create a new Expo project with [create-expo-app](https://github.com/expo/expo/tree/main/packages/create-expo#readme) instead: - - +```bash +# Usage for bun, npm, pnpm, and yarn +$ npm create expo +$ bun create expo +$ pnpm create expo +$ yarn create expo - +# Output help information with all available options +$ npx create-expo --help +``` -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! +
+
+ with ❤️  Expo +
+
diff --git a/src/__tests__/index.test.js b/src/__tests__/index.test.js index 04928fe..a6171fe 100644 --- a/src/__tests__/index.test.js +++ b/src/__tests__/index.test.js @@ -36,6 +36,6 @@ it('logs @react-native-community/cli as alternative', async () => { it('logs more information link', async () => { expect(await execute()).toMatchObject({ - stderr: expect.stringContaining('https://reactnative.dev/docs/getting-started'), + stderr: expect.stringContaining('https://reactnative.dev/docs/environment-setup'), }); }); diff --git a/src/index.ts b/src/index.ts index ae61021..7657ca4 100755 --- a/src/index.ts +++ b/src/index.ts @@ -12,7 +12,7 @@ It's recommended to use a framework to build apps with React Native, for example React Native Community template: {bold npx @react-native-community/cli init} -Learn more: {underline https://reactnative.dev/docs/getting-started} +Learn more: {underline https://reactnative.dev/docs/environment-setup} `); process.exit(1);