Skip to content
This repository has been archived by the owner on Jan 25, 2023. It is now read-only.

Commit

Permalink
docs: move global readme, fix ts readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Kurzdor committed Aug 6, 2020
1 parent bc7448d commit 8dd6cdd
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 17 deletions.
6 changes: 1 addition & 5 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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 ###
Expand Down
44 changes: 37 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 <project-name> --template effector
```

```via yarn:```

```bash
yarn create react-app <project-name> --template effector
```

```via pnpm:```

```bash
pnpx create-react-app <project-name> --template effector
```

### TypeScript template installation

```via npm:```

```bash
npx create-react-app <project-name> --template effector-typescript
```

```via yarn:```

```bash
npx create-react-app --template effector application-name
yarn create react-app <project-name> --template effector-typescript
```

# or
```via pnpm:```

yarn create react-app --template effector application-name
```bash
pnpx create-react-app <project-name> --template effector-typescript
```
10 changes: 5 additions & 5 deletions typescript/README.md
Original file line number Diff line number Diff line change
@@ -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 <project-name> --template effectorjs-typescript
npx create-react-app <project-name> --template effector-typescript
```

```yarn:```

```bash
yarn create react-app <project-name> --template effectorjs-typescript
yarn create react-app <project-name> --template effector-typescript
```

```pnpm:```

```bash
pnpx create-react-app <project-name> --template effectorjs-typescript
pnpx create-react-app <project-name> --template effector-typescript
```

For more information, please refer to:
Expand Down

0 comments on commit 8dd6cdd

Please sign in to comment.