Skip to content

Commit 04525e1

Browse files
committed
Merge branch 'chore/plm-6648-add-npm-publish' into release
2 parents 36015b8 + 5694b15 commit 04525e1

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
# eslint-config-ivy
22

33
> ⚠️ **CAUTION**
4-
> We now have a published package available on npm! However, for backward compatibility, we need to maintain two branches for now:
5-
>
6-
> - **`master`**: For legacy usage (`github:Houzz/eslint-config-ivy#master`).
7-
> - **`release`**: For the new npm 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.
4+
> We now have a published package available! However, for backward compatibility, we need to maintain two branches 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.
1010

1111
## Usage
1212

@@ -35,3 +35,10 @@ npm install github:Houzz/eslint-config-ivy#master
3535
"extends": ["eslint-config-ivy"]
3636
}
3737
```
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)