diff --git a/.gitignore b/.gitignore index 8fc14a1..74109f8 100644 --- a/.gitignore +++ b/.gitignore @@ -258,11 +258,7 @@ fabric.properties .idea/codestream.xml ### VisualStudioCode ### -.vscode/* -!.vscode/settings.json -!.vscode/tasks.json -!.vscode/launch.json -!.vscode/extensions.json +.vscode *.code-workspace ### VisualStudioCode Patch ### diff --git a/README.md b/README.md index ead0fa2..5549240 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,45 @@ -# CRA Template Effector +# ☄️ cra-template-effector -[![](https://img.shields.io/badge/feature/slices-1.0-blue)](https://featureslices.dev/v1.0) +The [Effector](https://effector.now.sh) vanilla JavaScript and TypeScript templates for bootstraping [Create React App](https://github.com/facebook/create-react-app) apps. -This template setup **effector** with **typescript** +## Install -## Installation +### Vanilla JavaScript template installation + +```via npm:``` + +```bash +npx create-react-app --template effector +``` + +```via yarn:``` + +```bash +yarn create react-app --template effector +``` + +```via pnpm:``` + +```bash +pnpx create-react-app --template effector +``` + +### TypeScript template installation + +```via npm:``` + +```bash +npx create-react-app --template effector-typescript +``` + +```via yarn:``` ```bash -npx create-react-app --template effector application-name +yarn create react-app --template effector-typescript +``` -# or +```via pnpm:``` -yarn create react-app --template effector application-name +```bash +pnpx create-react-app --template effector-typescript ``` diff --git a/typescript/README.md b/typescript/README.md index 227296f..923a8f0 100644 --- a/typescript/README.md +++ b/typescript/README.md @@ -1,25 +1,25 @@ # cra-template-effectorjs-typescript -The Effector template for [Create React App](https://github.com/facebook/create-react-app). +This is the official template for [Create React App](https://github.com/facebook/create-react-app) with Effector and TypeScript support. -To use this template, add `--template effectorjs-typescript` when creating a new app. +To use this template, add `--template effector-typescript` when creating a new app. ```npm:``` ```bash -npx create-react-app --template effectorjs-typescript +npx create-react-app --template effector-typescript ``` ```yarn:``` ```bash -yarn create react-app --template effectorjs-typescript +yarn create react-app --template effector-typescript ``` ```pnpm:``` ```bash -pnpx create-react-app --template effectorjs-typescript +pnpx create-react-app --template effector-typescript ``` For more information, please refer to: