Skip to content
This repository was archived by the owner on Mar 29, 2026. It is now read-only.

Commit 178fabb

Browse files
committed
docs: add npm and CI badges
Made-with: Cursor
1 parent cfdc7ad commit 178fabb

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# create-effector
22

33
[![npm version](https://img.shields.io/npm/v/create-effector.svg)](https://www.npmjs.com/package/create-effector)
4+
[![CI](https://github.com/effectorHQ/create-effector/actions/workflows/test.yml/badge.svg)](https://github.com/effectorHQ/create-effector/actions/workflows/test.yml)
45
[![Node.js Version](https://img.shields.io/badge/node-%3E%3D18-brightgreen)](https://nodejs.org/)
56
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
67
[![Effector Spec](https://img.shields.io/badge/spec-0.2.0-blue)](https://github.com/effectorHQ/effector-spec)
@@ -15,6 +16,21 @@ Scaffold a new [Effector](https://github.com/effectorHQ/effector-spec) project i
1516
npx create-effector my-skill --type skill
1617
```
1718

19+
## Install
20+
21+
```bash
22+
npm install -g @effectorhq/create-effector
23+
```
24+
25+
You can also use the CLI directly without installing globally:
26+
27+
```bash
28+
npx @effectorhq/create-effector my-skill
29+
npx @effectorhq/create-effector my-workspace --type workspace
30+
```
31+
32+
See the published package on npm: **https://www.npmjs.com/package/@effectorhq/create-effector**
33+
1834
## What It Does
1935

2036
Generates the correct project structure for any Effector type — manifest, entry files, CI, README, LICENSE — so you can start building immediately instead of copying boilerplate.

0 commit comments

Comments
 (0)