Skip to content

Commit de7d34e

Browse files
committed
doc: Update README for the migration info
1 parent d9385eb commit de7d34e

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,44 @@
11
# eslint-config-ivy
22

3+
> ⚠️ **CAUTION**
4+
> We now have a published package available! However, since package name has changed from `eslint-config-ivy` to `@houzz/eslint-config-ivy`, we need to maintain two branches for backward compatibility for now.
5+
6+
- master: For legacy usage (`github:Houzz/eslint-config-ivy#master`).
7+
- [release](https://github.com/Houzz/eslint-config-ivy/tree/release): For the new package (`@houzz/eslint-config-ivy`).
8+
9+
Please migrate all old usages to the new package as soon as possible. The legacy branch will eventually be deprecated.
10+
311
## Usage
412

13+
New (Recommended): Install the latest version from npm
14+
15+
```sh
16+
npm install @houzz/eslint-config-ivy --save-dev
17+
```
18+
19+
```json
20+
// .eslintrc
21+
{
22+
"extends": ["@houzz/eslint-config-ivy"]
23+
}
24+
```
25+
26+
Legacy (Deprecated): For temporary backward compatibility
27+
528
```sh
629
npm install github:Houzz/eslint-config-ivy#master
730
```
31+
32+
```json
33+
// .eslintrc
34+
{
35+
"extends": ["eslint-config-ivy"]
36+
}
37+
```
38+
39+
## Publish
40+
41+
Push to the `release` branch to publish the package.
42+
43+
- [Action](https://github.com/Houzz/eslint-config-ivy/actions/workflows/npmpublish.yml)
44+
- [Package](https://github.com/orgs/Houzz/packages/npm/package/eslint-config-ivy)

0 commit comments

Comments
 (0)